benchmark-ips 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bec7b23527f8a5f331788f9de05073eede35e26bbc5a6b81c05a609d964c0ff
-  data.tar.gz: aa8ba81457df018d94262d0eb722870d34406204d02a61b0ad1aa398fa2903ff
+  metadata.gz: 0516f3e1e35f43a8fe32a6f32357aa124478ba54228ffe57d928cfc1231851bc
+  data.tar.gz: d62da6a6c1d2696b7667bd125ffe6bb2c33b3d61da5c393e729d7ca8a3d70ee7
 SHA512:
-  metadata.gz: 0b8c313bd722fd52229c280d4d566fb9e246b8ae4253a0f508a5b9ca7fffd35cd780cc6c9aa96894733ee87d0df844feae530c10dbf38989cb07367094ce19f3
-  data.tar.gz: 037a07ffd3f129a06a68b5c53617379a9c7e3397fc9b02a961c7e7bb9b566f3ad0b423a43b3b5ed3e40f9edfac4f6eed810bc231c8e6d1398afaa65730d62946
+  metadata.gz: b644d293980f1ac9e3158abbe4f2c9d44d23185878edb9cb3861f3ca4f6837d557f89f8eb19bfcc42a45f53f3d112f2fe3ab22fc85a9633ede7e678b5fb90336
+  data.tar.gz: afe9972cdecdb2f42d4946afbac3d02cb3ead3a3d47a804960026ea77487cf885f6ddd7368edb13c522ee11e251599bf953d3d9a8172411c10e7259f7e9352b2

data/{History.txt → History.md}

@@ -1,26 +1,47 @@
-=== 2.9.0 / 2021-05-21
+### 2.10.0 / 2022-02-17
+
+* Feature
+  * Adds :order option to compare, with new `:baseline` order which compares all
+    variations against the first option benchmarked.
+
+### 2.9.3 / 2022-01-25
+
+* Bug fix
+  * All warmups and benchmarks must run at least once
+
+### 2.9.2 / 2021-10-10
+
+* Bug fix
+  * Fix a problem with certain configs of quiet mode
+
+### 2.9.1 / 2021-05-24
+
+* Bug fix
+  * Include all files in gem
+
+### 2.9.0 / 2021-05-21
 
 * Features
   * Suite can now be set via an accessor
   * Default SHARE_URL is now `ips.fastruby.io`, operated by Ombu Labs.
 
-=== 2.8.4 / 2020-12-03
+### 2.8.4 / 2020-12-03
 
 * Bug fix
   * Fixed hold! when results file does not exist.
 
-=== 2.8.3 / 2020-08-28
+### 2.8.3 / 2020-08-28
 
 * Bug fix
   * Fixed inaccuracy caused by integer overflows.
 
-=== 2.8.2 / 2020-05-04
+### 2.8.2 / 2020-05-04
 
 * Bug fix
   * Fixed problems with Manifest.txt.
   * Empty interim results files are ignored.
 
-=== 2.8.0 / 2020-05-01
+### 2.8.0 / 2020-05-01
 
 * Feature
   * Allow running with empty ips block.
@@ -33,16 +54,16 @@
   * Added some RDoc docs.
   * Added some examples in examples/
 
-=== 2.7.2 / 2016-08-18
+### 2.7.2 / 2016-08-18
 
 * 1 bug fix:
   * Restore old accessors. Fixes #76
 
-=== 2.7.1 / 2016-08-08
+### 2.7.1 / 2016-08-08
 
 Add missing files
 
-=== 2.7.0 / 2016-08-05
+### 2.7.0 / 2016-08-05
 
 * 1 minor features:
   * Add support for confidence intervals
@@ -59,9 +80,9 @@ Add missing files
   * Merge pull request #67 from benoittgt/master
   * Merge pull request #69 from chrisseaton/kalibera-confidence-intervals
 
-=== MISSING 2.6.0 and 2.6.1
+### MISSING 2.6.0 and 2.6.1
 
-=== 2.5.0 / 2016-02-14
+### 2.5.0 / 2016-02-14
 
 * 1 minor feature:
   * Add iterations option.
@@ -73,12 +94,12 @@ Add missing files
   * Merge pull request #58 from chrisseaton/iterations
   * Merge pull request #60 from chrisseaton/significance
 
-=== 2.4.1 / 2016-02-12
+### 2.4.1 / 2016-02-12
 
 * 1 bug fix:
   * Add missing files to gem
 
-=== 2.4.0 / 2016-02-12
+### 2.4.0 / 2016-02-12
 
 * 1 minor features
   * Add support for hold! and independent invocations.
@@ -113,7 +134,7 @@ Add missing files
   * Merge pull request #56 from chrisseaton/independence
   * Merge pull request #57 from chrisseaton/tighten-loop
 
-=== 2.3.0 / 2015-07-20
+### 2.3.0 / 2015-07-20
 
 * 2 minor features:
   * Support keyword arguments
@@ -127,7 +148,7 @@ Add missing files
   * Merge pull request #42 from kbrock/newer_travis
   * Merge pull request #43 from kbrock/non_to_s_labels
 
-=== 2.2.0 / 2015-05-09
+### 2.2.0 / 2015-05-09
 
 * 1 minor features:
   * Fix quiet mode
@@ -151,7 +172,7 @@ Add missing files
   * Merge pull request #29 from JuanitoFatas/feature/json-export
   * Merge pull request #26 from JuanitoFatas/feature/takes-symbol-as-report-parameter
 
-=== 2.1.1 / 2015-01-12
+### 2.1.1 / 2015-01-12
 
 * 1 minor fix:
   * Don't send label through printf so that % work directly
@@ -165,7 +186,7 @@ Add missing files
 * 1 PR merged:
   * Merge pull request #24 from zzak/simple-format-result-description
 
-=== 2.1.0 / 2014-11-10
+### 2.1.0 / 2014-11-10
 
 * Documentation changes:
   * Many documentation fixes by Juanito Fatas!
@@ -176,7 +197,7 @@ Add missing files
   * Formatting of large values improved (human vs raw mode)
     * Contributed by Charles Oliver Nutter
 
-=== 2.0.0 / 2014-06-18
+### 2.0.0 / 2014-06-18
 
 * The 'Davy Stevenson' release!
   * Codename: Springtime Hummingbird Dance
@@ -194,7 +215,7 @@ Add missing files
   *  Zachary Scott
   *  schneems (Richard Schneeman)
 
-=== 1.0.0 / 2012-03-23
+### 1.0.0 / 2012-03-23
 
 * 1 major enhancement
 

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Evan Phoenix
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -254,27 +254,3 @@ After checking out the source, run:
 This task will install any missing dependencies, run the tests/specs,
 and generate the RDoc.
 
-## LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2015 Evan Phoenix
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/examples/advanced.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'benchmark/ips'
+
+Benchmark.ips do |x|
+
+  # Use bootstrap confidence intervals
+  x.stats = :bootstrap
+
+  # Set confidence to 95%
+  x.confidence = 95
+
+  # Run multiple iterations for better warmup
+  x.iterations = 3
+
+  x.report("mul") { 2 * 2 * 2 * 2 * 2 * 2 * 2 * 2 }
+  x.report("pow") { 2 ** 8 }
+
+  x.compare!
+end

data/examples/hold.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# example to explain hold! usage https://github.com/evanphx/benchmark-ips/issues/85
+# The hold! feature expects to be run twice, generally with different Rubys.
+# hold! can also be used to compare modules changes which impact the run time
+# RUN_1: ruby examples/hold.rb
+# Warming up --------------------------------------
+#             without   172.168k i/100ms
+# Calculating -------------------------------------
+#             without      2.656M (± 3.3%) i/s -     13.429M in   5.062098s
+#
+# RUN_2: WITH_MODULE=true ruby examples/hold.rb
+# Warming up --------------------------------------
+#                 with    92.087k i/100ms
+# Calculating -------------------------------------
+#                 with      1.158M (± 1.4%) i/s -      5.801M in   5.010084s
+#
+# Comparison:
+#              without:  2464721.3 i/s
+#                 with:  1158179.6 i/s - 2.13x  slower
+require 'benchmark/ips'
+
+Benchmark.ips do |x|
+  x.report('without') do
+    'Bruce'.inspect
+  end
+
+  if ENV['WITH_MODULE'] == 'true'
+    class String
+      def inspect
+        result = %w[Bruce Wayne is Batman]
+        result.join(' ')
+      end
+    end
+  end
+
+  x.report('with') do
+    'Bruce'.inspect
+  end
+  x.hold! 'temp_results'
+  x.compare!
+end

data/examples/save.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+# example to explain save!
+# The save! feature expects to be run twice, generally with different Rubys.
+# save! can also be used to compare modules changes which impact the run time
+#
+# If you're comparing ruby versions, Just use the version in the label
+#
+#     x.report("ruby #{RUBY_VERSION}") { 'Bruce'.inspect }
+#
+# Or use a hash
+# 
+#     x.report("version" => RUBY_VERSION, "method" => 'bruce') { 'Bruce'.inspect }
+#
+# RUN_1: SAVE_FILE='run1.out' ruby examples/hold.rb
+# Warming up --------------------------------------
+#             without   172.168k i/100ms
+# Calculating -------------------------------------
+#             without      2.656M (± 3.3%) i/s -     13.429M in   5.062098s
+#
+# RUN_2: SAVE_FILE='run1.out' WITH_MODULE=true ruby examples/hold.rb
+# Warming up --------------------------------------
+#                 with    92.087k i/100ms
+# Calculating -------------------------------------
+#                 with      1.158M (± 1.4%) i/s -      5.801M in   5.010084s
+#
+# Comparison:
+#              without:  2464721.3 i/s
+#                 with:  1158179.6 i/s - 2.13x  slower
+# CLEANUP: rm run1.out
+
+require 'benchmark/ips'
+
+Benchmark.ips do |x|
+  x.report(ENV['WITH_MODULE'] == 'true' ? 'with' : 'without') do
+    'Bruce'.inspect
+  end
+
+  if ENV['WITH_MODULE'] == 'true'
+    class String
+      def inspect
+        result = %w[Bruce Wayne is Batman]
+        result.join(' ')
+      end
+    end
+  end
+
+  x.save! ENV['SAVE_FILE'] if ENV['SAVE_FILE']
+  x.compare!
+end

data/examples/simple.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require 'benchmark/ips'
+
+Benchmark.ips do |x|
+
+  # Configure the number of seconds used during
+  # the warmup phase and calculation phase
+  x.config(:time => 5, :warmup => 2)
+
+  # These parameters can also be configured this way
+  x.time = 5
+  x.warmup = 2
+
+  # Typical mode, runs the block as many times as it can
+  x.report("addition") { 1 + 2 }
+
+  # To reduce overhead, the number of iterations is passed in
+  # and the block must run the code the specific number of times.
+  # Used for when the workload is very small and any overhead
+  # introduces incorrectable errors.
+  x.report(:addition2) do |times|
+    i = 0
+    while i < times
+      1 + 2
+      i += 1
+    end
+  end
+
+  # To reduce overhead even more, grafts the code given into
+  # the loop that performs the iterations internally to reduce
+  # overhead. Typically not needed, use the |times| form instead.
+  x.report("addition3", "1 + 2")
+
+  # Really long labels should be formatted correctly
+  x.report("addition-test-long-label") { 1 + 2 }
+
+  x.compare!
+end
+
+puts <<-EOD
+Typical results will show addition2 & addition3 to be the most performant, and
+they should perform reasonably similarly. You should see addition and
+addition-test-long-label to perform very similarly to each other (as they are
+running the same test, just with different labels), and they should both run in
+the neighborhood of 3.5 times slower than addition2 and addition3."
+EOD

data/lib/benchmark/compare.rb

@@ -26,31 +26,67 @@ module Benchmark
   #   Reduce using to_proc:   247295.4 i/s - 1.13x slower
   #
   # Besides regular Calculating report, this will also indicates which one is slower.
+  #
+  # +x.compare!+ also takes an +order: :baseline+ option.
+  #
+  # Example:
+  #  > Benchmark.ips do |x|
+  #   x.report('Reduce using block')   { [*1..10].reduce { |sum, n| sum + n } }
+  #   x.report('Reduce using tag')     { [*1..10].reduce(:+) }
+  #   x.report('Reduce using to_proc') { [*1..10].reduce(&:+) }
+  #   x.compare!(order: :baseline)
+  # end
+  #
+  # Calculating -------------------------------------
+  #   Reduce using block    886.202k (± 2.2%) i/s -      4.521M in   5.103774s
+  #     Reduce using tag      1.821M (± 1.6%) i/s -      9.111M in   5.004183s
+  # Reduce using to_proc    895.948k (± 1.6%) i/s -      4.528M in   5.055368s
+  #
+  # Comparison:
+  #   Reduce using block:   886202.5 i/s
+  #     Reduce using tag:  1821055.0 i/s - 2.05x  (± 0.00) faster
+  # Reduce using to_proc:   895948.1 i/s - same-ish: difference falls within error
+  #
+  # The first report is considered the baseline against which other reports are compared.
   module Compare
 
     # Compare between reports, prints out facts of each report:
     # runtime, comparative speed difference.
     # @param entries [Array<Report::Entry>] Reports to compare.
-    def compare(*entries)
+    def compare(*entries, order: :fastest)
       return if entries.size < 2
 
-      sorted = entries.sort_by{ |e| e.stats.central_tendency }.reverse
-
-      best = sorted.shift
+      case order
+      when :baseline
+        baseline = entries.shift
+        sorted = entries.sort_by{ |e| e.stats.central_tendency }.reverse
+      when :fastest
+        sorted = entries.sort_by{ |e| e.stats.central_tendency }.reverse
+        baseline = sorted.shift
+      else
+        raise ArgumentError, "Unknwon order: #{order.inspect}"
+      end
 
       $stdout.puts "\nComparison:"
 
-      $stdout.printf "%20s: %10.1f i/s\n", best.label.to_s, best.stats.central_tendency
+      $stdout.printf "%20s: %10.1f i/s\n", baseline.label.to_s, baseline.stats.central_tendency
 
       sorted.each do |report|
         name = report.label.to_s
 
         $stdout.printf "%20s: %10.1f i/s - ", name, report.stats.central_tendency
 
-        if report.stats.overlaps?(best.stats)
+        if report.stats.overlaps?(baseline.stats)
           $stdout.print "same-ish: difference falls within error"
+        elsif report.stats.central_tendency > baseline.stats.central_tendency
+          speedup, error = report.stats.speedup(baseline.stats)
+          $stdout.printf "%.2fx ", speedup
+          if error
+            $stdout.printf " (± %.2f)", error
+          end
+          $stdout.print " faster"
         else
-          slowdown, error = report.stats.slowdown(best.stats)
+          slowdown, error = report.stats.slowdown(baseline.stats)
           $stdout.printf "%.2fx ", slowdown
           if error
             $stdout.printf " (± %.2f)", error
@@ -61,7 +97,7 @@ module Benchmark
         $stdout.puts
       end
 
-      footer = best.stats.footer
+      footer = baseline.stats.footer
       $stdout.puts footer.rjust(40) if footer
 
       $stdout.puts

data/lib/benchmark/ips/job/noop_report.rb

@@ -0,0 +1,27 @@
+module Benchmark
+  module IPS
+    class Job
+      class NoopReport
+        def start_warming
+        end
+
+        def start_running
+        end
+
+        def footer
+        end
+
+        def warming(a, b)
+        end
+
+        def warmup_stats(a, b)
+        end
+
+        def add_report(a, b)
+        end
+
+        alias_method :running, :warming
+      end
+    end
+  end
+end

data/lib/benchmark/ips/job.rb

@@ -65,6 +65,7 @@ module Benchmark
         @run_single = false
         @json_path = false
         @compare = false
+        @compare_order = :fastest
         @held_path = nil
         @held_results = nil
 
@@ -79,6 +80,8 @@ module Benchmark
         # Default statistical model
         @stats = :sd
         @confidence = 95
+
+        self.quiet = false
       end
 
       # Job configuration options, set +@warmup+ and +@time+.
@@ -92,7 +95,7 @@ module Benchmark
         @iterations = opts[:iterations] if opts[:iterations]
         @stats = opts[:stats] if opts[:stats]
         @confidence = opts[:confidence] if opts[:confidence]
-        self.quiet = opts[:quiet]
+        self.quiet = opts[:quiet] if opts.key?(:quiet)
         self.suite = opts[:suite]
       end
 
@@ -115,8 +118,9 @@ module Benchmark
       end
 
       # Run comparison utility.
-      def compare!
+      def compare!(order: :fastest)
         @compare = true
+        @compare_order = order
       end
 
       # Return true if results are held while multiple Ruby invocations
@@ -274,9 +278,7 @@ module Benchmark
           target = Timing.add_second before, @warmup / 2.0
 
           cycles = 1
-          warmup_iter = 1
-          warmup_time_us = 0.0
-          while Timing.now + warmup_time_us * 2 < target
+          begin
             t0 = Timing.now
             item.call_times cycles
             t1 = Timing.now
@@ -287,7 +289,7 @@ module Benchmark
             # then exit the loop to avoid overflows and start the 100ms warmup runs
             break if cycles >= POW_2_30
             cycles *= 2
-          end
+          end while Timing.now + warmup_time_us * 2 < target
 
           cycles = cycles_per_100ms warmup_time_us, warmup_iter
           @timing[item] = cycles
@@ -324,7 +326,8 @@ module Benchmark
 
           target = Timing.add_second Timing.now, @time
 
-          while (before = Timing.now) < target
+          begin
+            before = Timing.now
             item.call_times cycles
             after = Timing.now
 
@@ -336,7 +339,7 @@ module Benchmark
             iter += cycles
 
             measurements_us << iter_us
-          end
+          end while Timing.now < target
 
           final_time = before
 
@@ -372,7 +375,7 @@ module Benchmark
 
       # Run comparison of entries in +@full_report+.
       def run_comparison
-        @full_report.run_comparison if compare?
+        @full_report.run_comparison(@compare_order) if compare?
       end
 
       # Generate json from +@full_report+.

data/lib/benchmark/ips/noop_suite.rb

@@ -0,0 +1,25 @@
+module Benchmark
+  module IPS
+    class NoopSuite
+      def start_warming
+      end
+
+      def start_running
+      end
+
+      def footer
+      end
+
+      def warming(a, b)
+      end
+
+      def warmup_stats(a, b)
+      end
+
+      def add_report(a, b)
+      end
+
+      alias_method :running, :warming
+    end
+  end
+end

data/lib/benchmark/ips/report.rb

@@ -176,8 +176,8 @@ module Benchmark
       end
 
       # Run comparison of entries.
-      def run_comparison
-        Benchmark.compare(*@entries)
+      def run_comparison(order)
+        Benchmark.compare(*@entries, order: order)
       end
 
       # Generate json from Report#data to given path.

data/lib/benchmark/ips/stats/bootstrap.rb

@@ -33,6 +33,10 @@ module Benchmark
           [slowdown, error]
         end
 
+        def speedup(baseline)
+          baseline.slowdown(self)
+        end
+
         def footer
           "with #{(@confidence.to_f * 100).round(1)}% confidence"
         end

data/lib/benchmark/ips/stats/sd.rb

@@ -30,6 +30,10 @@ module Benchmark
           end
         end
 
+        def speedup(baseline)
+          baseline.slowdown(self)
+        end
+
         def footer
           nil
         end

data/lib/benchmark/ips.rb

@@ -18,10 +18,10 @@ module Benchmark
   module IPS
 
     # Benchmark-ips Gem version.
-    VERSION = "2.9.0"
+    VERSION = "2.10.0"
 
     # CODENAME of current version.
-    CODENAME = "Sleepy Sasquatch"
+    CODENAME = "Watashi Wa Genki"
 
     # Measure code in block, each code's benchmarked result will display in
     # iteration per second with standard deviation in given time.

metadata

@@ -1,95 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-ips
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.10.0
 platform: ruby
 authors:
 - Evan Phoenix
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
-  name: minitest
-  prerelease: false
+        version: '5.4'
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.4'
 - !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
   name: rdoc
-  prerelease: false
-  type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.22'
-  name: hoe
-  prerelease: false
+        version: '4.0'
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.22'
-description: An iterations per second enhancement to Benchmark.
+        version: '4.0'
+description: A iterations per second enhancement to Benchmark.
 email:
 - evan@phx.io
 executables: []
 extensions: []
 extra_rdoc_files:
-- History.txt
-- Manifest.txt
+- History.md
+- LICENSE
 - README.md
 files:
-- ".autotest"
-- History.txt
-- Manifest.txt
+- History.md
+- LICENSE
 - README.md
-- Rakefile
+- examples/advanced.rb
+- examples/hold.rb
+- examples/save.rb
+- examples/simple.rb
 - lib/benchmark/compare.rb
 - lib/benchmark/ips.rb
 - lib/benchmark/ips/job.rb
 - lib/benchmark/ips/job/entry.rb
+- lib/benchmark/ips/job/noop_report.rb
 - lib/benchmark/ips/job/stdout_report.rb
+- lib/benchmark/ips/noop_suite.rb
 - lib/benchmark/ips/report.rb
 - lib/benchmark/ips/share.rb
 - lib/benchmark/ips/stats/bootstrap.rb
 - lib/benchmark/ips/stats/sd.rb
 - lib/benchmark/ips/stats/stats_metric.rb
 - lib/benchmark/timing.rb
-- test/test_benchmark_ips.rb
 homepage: https://github.com/evanphx/benchmark-ips
 licenses:
 - MIT
-metadata:
-  homepage_uri: https://github.com/evanphx/benchmark-ips
+metadata: {}
 post_install_message:
 rdoc_options:
 - "--main"
@@ -107,8 +89,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.26
 signing_key:
 specification_version: 4
-summary: An iterations per second enhancement to Benchmark.
+summary: A iterations per second enhancement to Benchmark.
 test_files: []

data/.autotest

@@ -1,23 +0,0 @@
-# -*- ruby -*-
-
-require 'autotest/restart'
-
-# Autotest.add_hook :initialize do |at|
-#   at.extra_files << "../some/external/dependency.rb"
-#
-#   at.libs << ":../some/external"
-#
-#   at.add_exception 'vendor'
-#
-#   at.add_mapping(/dependency.rb/) do |f, _|
-#     at.files_matching(/test_.*rb$/)
-#   end
-#
-#   %w(TestA TestB).each do |klass|
-#     at.extra_class_map[klass] = "test/test_misc.rb"
-#   end
-# end
-
-# Autotest.add_hook :run_command do |at|
-#   system "rake build"
-# end

data/Manifest.txt

@@ -1,17 +0,0 @@
-.autotest
-History.txt
-Manifest.txt
-README.md
-Rakefile
-lib/benchmark/compare.rb
-lib/benchmark/ips.rb
-lib/benchmark/ips/job.rb
-lib/benchmark/ips/job/entry.rb
-lib/benchmark/ips/job/stdout_report.rb
-lib/benchmark/ips/report.rb
-lib/benchmark/ips/share.rb
-lib/benchmark/ips/stats/bootstrap.rb
-lib/benchmark/ips/stats/sd.rb
-lib/benchmark/ips/stats/stats_metric.rb
-lib/benchmark/timing.rb
-test/test_benchmark_ips.rb

data/Rakefile

@@ -1,27 +0,0 @@
-# -*- ruby -*-
-
-require 'rubygems'
-require 'hoe'
-
-Hoe.plugin :minitest
-Hoe.plugin :git
-Hoe.plugin :ignore
-
-hoe = Hoe.spec 'benchmark-ips' do
-  developer('Evan Phoenix', 'evan@phx.io')
-
-  self.readme_file = 'README.md'
-
-  license "MIT"
-end
-
-file "#{hoe.spec.name}.gemspec" => ['Rakefile', "lib/benchmark/ips.rb"] do |t|
-  puts "Generating #{t.name}"
-  File.open(t.name, 'wb') { |f| f.write hoe.spec.to_ruby }
-end
-
-desc "Generate or update the standalone gemspec file for the project"
-task :gemspec => ["#{hoe.spec.name}.gemspec"]
-
-
-# vim: syntax=ruby

data/test/test_benchmark_ips.rb

@@ -1,221 +0,0 @@
-require "minitest/autorun"
-require "benchmark/ips"
-require "stringio"
-require "tmpdir"
-
-class TestBenchmarkIPS < Minitest::Test
-  def setup
-    @old_stdout = $stdout
-    $stdout = StringIO.new
-  end
-
-  def teardown
-    $stdout = @old_stdout
-  end
-
-  def test_kwargs
-    Benchmark.ips(:time => 1, :warmup => 1, :quiet => false) do |x|
-      x.report("sleep 0.25") { sleep(0.25) }
-    end
-
-    assert $stdout.string.size > 0
-  end
-
-  def test_warmup0
-    $stdout = @old_stdout
-
-    out, err = capture_io do
-      Benchmark.ips(:time => 1, :warmup => 0, :quiet => false) do |x|
-        x.report("sleep 0.25") { sleep(0.25) }
-      end
-    end
-
-    refute_match(/Warming up -+/, out)
-    assert_empty err
-  end
-
-  def test_output
-    Benchmark.ips(1) do |x|
-      x.report("operation") { 100 * 100 }
-    end
-
-    assert $stdout.string.size > 0
-  end
-
-  def test_quiet
-    Benchmark.ips(1, nil, true) do |x|
-      x.report("operation") { 100 * 100 }
-    end
-
-    assert $stdout.string.size.zero?
-
-    Benchmark.ips(:quiet => true) do |x|
-      x.report("operation") { 100 * 100 }
-    end
-
-    assert $stdout.string.size.zero?
-
-    Benchmark.ips do |x|
-      x.quiet = true
-      x.report("operation") { 100 * 100 }
-    end
-
-    assert $stdout.string.size.zero?
-  end
-
-  def test_ips
-    report = Benchmark.ips do |x|
-      x.config(:time => 1, :warmup => 1)
-      x.report("sleep 0.25") { sleep(0.25) }
-      x.report("sleep 0.05") { sleep(0.05) }
-      x.compare!
-    end
-
-    rep1 = report.entries[0]
-    rep2 = report.entries[1]
-
-    assert_equal "sleep 0.25", rep1.label
-    assert_equal 4, rep1.iterations
-    assert_in_delta 4.0, rep1.ips, 0.2
-
-    assert_equal "sleep 0.05", rep2.label
-    assert_in_delta 20.0, rep2.iterations.to_f, 1.0
-    assert_in_delta 20.0, rep2.ips, 2.0
-  end
-
-  def test_ips_alternate_config
-    report = Benchmark.ips do |x|
-      x.time = 1
-      x.warmup = 1
-      x.report("sleep 0.25") { sleep(0.25) }
-    end
-
-    rep = report.entries.first
-
-    assert_equal "sleep 0.25", rep.label
-    assert_equal 4, rep.iterations
-    assert_in_delta 4.0, rep.ips, 0.4
-  end
-
-  def test_ips_old_config
-    report = Benchmark.ips(1,1) do |x|
-      x.report("sleep 0.25") { sleep(0.25) }
-    end
-
-    rep = report.entries.first
-
-    assert_equal "sleep 0.25", rep.label
-    assert_equal 4, rep.iterations
-    assert_in_delta 4.0, rep.ips, 0.2
-  end
-
-  def test_ips_config_suite
-    suite = Struct.new(:calls) do
-      def method_missing(method, *args)
-        calls << method
-      end
-    end.new([])
-
-    Benchmark.ips(0.1, 0.1) do |x|
-      x.config(:suite => suite)
-      x.report("job") {}
-    end
-
-    assert_equal [:warming, :warmup_stats, :running, :add_report], suite.calls
-  end
-
-  def test_ips_config_suite_by_accsr
-    suite = Struct.new(:calls) do
-      def method_missing(method, *args)
-        calls << method
-      end
-    end.new([])
-
-    Benchmark.ips(0.1, 0.1) do |x|
-      x.suite = suite
-      x.report("job") {}
-    end
-
-    assert_equal [:warming, :warmup_stats, :running, :add_report], suite.calls
-  end
-
-  def test_ips_defaults
-    report = Benchmark.ips do |x|
-      x.report("sleep 0.25") { sleep(0.25) }
-    end
-
-    rep = report.entries.first
-
-    assert_equal "sleep 0.25", rep.label
-    assert_equal 4*5, rep.iterations
-    assert_in_delta 4.0, rep.ips, 0.2
-  end
-
-  def test_ips_report_using_symbol
-    report = Benchmark.ips do |x|
-      x.report(:sleep_a_quarter_second) { sleep(0.25) }
-    end
-
-    rep = report.entries.first
-
-    assert_equal :sleep_a_quarter_second, rep.label
-    assert_equal 4*5, rep.iterations
-    assert_in_delta 4.0, rep.ips, 0.2
-  end
-
-  def test_ips_default_data
-    report = Benchmark.ips do |x|
-      x.report("sleep 0.25") { sleep(0.25) }
-    end
-
-    all_data = report.data
-
-    assert all_data
-    assert_equal "sleep 0.25", all_data[0][:name]
-    assert all_data[0][:ips]
-    assert all_data[0][:stddev]
-  end
-
-  def test_ips_empty
-    report = Benchmark.ips do |_x|
-
-    end
-
-    all_data = report.data
-
-    assert all_data
-    assert_equal [], all_data
-  end
-
-  def test_json_output
-    json_file = Tempfile.new("data.json")
-
-    Benchmark.ips do |x|
-      x.report("sleep 0.25") { sleep(0.25) }
-      x.json! json_file.path
-    end
-
-    json_data = json_file.read
-    assert json_data
-
-    data = JSON.parse json_data
-    assert data
-    assert_equal 1, data.size
-    assert_equal "sleep 0.25", data[0]["name"]
-    assert data[0]["ips"]
-    assert data[0]["stddev"]
-  end
-
-  def test_hold!
-    temp_file_name = Dir::Tmpname.create(["benchmark-ips", ".tmp"]) { }
-
-    Benchmark.ips(:time => 0.001, :warmup => 0.001) do |x|
-      x.report("operation") { 100 * 100 }
-      x.report("operation2") { 100 * 100 }
-      x.hold! temp_file_name
-    end
-
-    assert File.exist?(temp_file_name)
-    File.unlink(temp_file_name)
-  end
-end