benchmark-ips 2.11.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 194a6da5977a23dc733ade6dadaefe1a7d7215678d6135ff33d5c37304bec993
-  data.tar.gz: e072ffd46009a79e13990e7435e1415ec24fd0407f86d566208fc597b8e33f7d
+  metadata.gz: bc54b5cf0d24b23822486adf5759cceeefbef9a60c780454318472f4739050f6
+  data.tar.gz: ea2764b060fef8c931c4636eb63e84d48f98242f7335648fed8b82b2fdeb053d
 SHA512:
-  metadata.gz: 5b3a8e41f223d3945daf11329e7cd68b1cc41f9b08b9f3f2e9e5a471a37134782f4e1f78caca102b7b3b08eb179ac4d78868bb1f97bfab4ac1ccef22aa38d42d
-  data.tar.gz: e5cd27c03050929b8edf402264c0f5a32560550ee6d79456d2513ae9b4a76f763f669a32ba4cc3bf7a45e7c086426631c2ba26724a749192fc637046bfd6a495
+  metadata.gz: 72ed2d83e42b125ca812aa1e79113be4726f8bb2e0ca4cb784dddc1d70eddc16c088308e1214cba9f7ec83ad77d89d9ae544b7892b6abac8f3e0b88d1617e7a8
+  data.tar.gz: 94bda95d5db4a9032692e732a04eb3147ad3839b0e674f13d676b1fdf2130a8f0a269e6f5817791683965bf86662be10c7e5476e0539d71916b6b35562ac7806

data/History.md

@@ -1,3 +1,8 @@
+### 2.12.0 / 2023-03-08
+
+* Feature
+  * Adds MultiReport and ability report to a stream rather than a string.
+
 ### 2.11.0 / 2023-02-15
 
 * Feature

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

@@ -0,0 +1,67 @@
+module Benchmark
+  module IPS
+    class Job
+      class MultiReport
+        # @returns out [Array<StreamReport>] list of reports to send output
+        attr_accessor :out
+
+        def empty?
+          @out.empty?
+        end
+
+        def quiet?
+          @out.none? { |rpt| rpt.kind_of?(StreamReport) }
+        end
+
+        def quiet!
+          @out.delete_if { |rpt| rpt.kind_of?(StreamReport) }
+        end
+
+        # @param report [StreamReport] report to accept input?
+        def <<(report)
+          if report.kind_of?(MultiReport)
+            self << report.out
+          elsif report.kind_of?(Enumerable)
+            @out += report
+          elsif report
+            @out << report
+          end
+        end
+
+        # @param out [Array<StreamReport>] list of reports to send output
+        def initialize(out = nil)
+          @out = []
+          self << out
+        end
+
+        def start_warming
+          @out.each { |o| o.start_warming if o.respond_to?(:start_warming) }
+        end
+
+        def warming(label, warmup)
+          @out.each { |o| o.warming(label, warmup) }
+        end
+
+        def warmup_stats(warmup_time_us, timing)
+          @out.each { |o| o.warmup_stats(warmup_time_us, timing) }
+        end
+
+        def start_running
+          @out.each { |o| o.start_running if o.respond_to?(:start_running) }
+        end
+
+        def running(label, warmup)
+          @out.each { |o| o.running(label, warmup) }
+        end
+
+        def add_report(item, caller)
+          @out.each { |o| o.add_report(item, caller) }
+        end
+
+        def footer
+          @out.each { |o| o.footer if o.respond_to?(:footer) }
+        end
+      end
+    end
+  end
+end

data/lib/benchmark/ips/job/{stdout_report.rb → stream_report.rb}

@@ -1,43 +1,45 @@
 module Benchmark
   module IPS
     class Job
-      class StdoutReport
-        def initialize
+      class StreamReport
+        def initialize(stream = $stdout)
           @last_item = nil
+          @out = stream
         end
 
         def start_warming
-          $stdout.puts "Warming up --------------------------------------"
+          @out.puts RUBY_DESCRIPTION
+          @out.puts "Warming up --------------------------------------"
         end
 
         def start_running
-          $stdout.puts "Calculating -------------------------------------"
+          @out.puts "Calculating -------------------------------------"
         end
 
         def warming(label, _warmup)
-          $stdout.print rjust(label)
+          @out.print rjust(label)
         end
 
         def warmup_stats(_warmup_time_us, timing)
           case format
           when :human
-            $stdout.printf "%s i/100ms\n", Helpers.scale(timing)
+            @out.printf "%s i/100ms\n", Helpers.scale(timing)
           else
-            $stdout.printf "%10d i/100ms\n", timing
+            @out.printf "%10d i/100ms\n", timing
           end
         end
 
         alias_method :running, :warming
 
         def add_report(item, caller)
-          $stdout.puts " #{item.body}"
+          @out.puts " #{item.body}"
           @last_item = item
         end
 
         def footer
           return unless @last_item
           footer = @last_item.stats.footer
-          $stdout.puts footer.rjust(40) if footer
+          @out.puts footer.rjust(40) if footer
         end
 
         private

data/lib/benchmark/ips/job.rb

@@ -53,11 +53,15 @@ module Benchmark
 
       # Silence output
       # @return [Boolean]
-      attr_reader :quiet
+      def quiet
+        @out.quiet?
+      end
 
       # Suite
-      # @return [Benchmark::IPS::NoopSuite]
-      attr_reader :suite
+      # @return [Benchmark::IPS::MultiReport]
+      def suite
+        @out
+      end
 
       # Instantiate the Benchmark::IPS::Job.
       def initialize opts={}
@@ -81,7 +85,7 @@ module Benchmark
         @stats = :sd
         @confidence = 95
 
-        self.quiet = false
+        @out = MultiReport.new(StreamReport.new)
       end
 
       # Job configuration options, set +@warmup+ and +@time+.
@@ -91,24 +95,23 @@ module Benchmark
       def config opts
         @warmup = opts[:warmup] if opts[:warmup]
         @time = opts[:time] if opts[:time]
-        @suite = opts[:suite] if opts[:suite]
         @iterations = opts[:iterations] if opts[:iterations]
         @stats = opts[:stats] if opts[:stats]
         @confidence = opts[:confidence] if opts[:confidence]
         self.quiet = opts[:quiet] if opts.key?(:quiet)
-        self.suite = opts[:suite]
+        self.suite = opts[:suite] if opts[:suite]
       end
 
       def quiet=(val)
-        @stdout = reporter(quiet: val)
+        if val # remove instances of StreamReport
+          @out.quiet!
+        else # ensure there is an instance of StreamReport
+          @out << StreamReport.new if @out.quiet?
+        end
       end
 
       def suite=(suite)
-        @suite = suite || Benchmark::IPS::NoopSuite.new
-      end
-
-      def reporter(quiet:)
-        quiet ? NoopReport.new : StdoutReport.new
+        @out << suite
       end
 
       # Return true if job needs to be compared.
@@ -245,19 +248,19 @@ module Benchmark
 
       def run
         if @warmup && @warmup != 0 then
-          @stdout.start_warming
+          @out.start_warming
           @iterations.times do
             run_warmup
           end
         end
 
-        @stdout.start_running
+        @out.start_running
 
         @iterations.times do |n|
           run_benchmark
         end
 
-        @stdout.footer
+        @out.footer
       end
 
       # Run warmup.
@@ -265,8 +268,7 @@ module Benchmark
         @list.each do |item|
           next if run_single? && @held_results && @held_results.key?(item.label)
 
-          @suite.warming item.label, @warmup
-          @stdout.warming item.label, @warmup
+          @out.warming item.label, @warmup
 
           Timing.clean_env
 
@@ -300,8 +302,7 @@ module Benchmark
             item.call_times cycles
           end
 
-          @stdout.warmup_stats warmup_time_us, @timing[item]
-          @suite.warmup_stats warmup_time_us, @timing[item]
+          @out.warmup_stats warmup_time_us, @timing[item]
 
           break if run_single?
         end
@@ -312,8 +313,7 @@ module Benchmark
         @list.each do |item|
           next if run_single? && @held_results && @held_results.key?(item.label)
 
-          @suite.running item.label, @time
-          @stdout.running item.label, @time
+          @out.running item.label, @time
 
           Timing.clean_env
 
@@ -355,8 +355,7 @@ module Benchmark
             rep.show_total_time!
           end
 
-          @stdout.add_report rep, caller(1).first
-          @suite.add_report rep, caller(1).first
+          @out.add_report rep, caller(1).first
 
           break if run_single?
         end

data/lib/benchmark/ips.rb

@@ -5,10 +5,9 @@ require 'benchmark/ips/stats/stats_metric'
 require 'benchmark/ips/stats/sd'
 require 'benchmark/ips/stats/bootstrap'
 require 'benchmark/ips/report'
-require 'benchmark/ips/noop_suite'
 require 'benchmark/ips/job/entry'
-require 'benchmark/ips/job/stdout_report'
-require 'benchmark/ips/job/noop_report'
+require 'benchmark/ips/job/stream_report'
+require 'benchmark/ips/job/multi_report'
 require 'benchmark/ips/job'
 
 # Performance benchmarking library
@@ -18,10 +17,10 @@ module Benchmark
   module IPS
 
     # Benchmark-ips Gem version.
-    VERSION = "2.11.0"
+    VERSION = "2.13.0"
 
     # CODENAME of current version.
-    CODENAME = "We Do This Once A Year"
+    CODENAME = "Long Awaited"
 
     # Measure code in block, each code's benchmarked result will display in
     # iteration per second with standard deviation in given time.
@@ -83,20 +82,15 @@ module Benchmark
     end
 
     module Helpers
+      SUFFIXES = ['', 'k', 'M', 'B', 'T', 'Q'].freeze
+    
       def scale(value)
-        scale = (Math.log10(value) / 3).to_i
-        suffix = case scale
-        when 1; 'k'
-        when 2; 'M'
-        when 3; 'B'
-        when 4; 'T'
-        when 5; 'Q'
-        else
-          # < 1000 or > 10^15, no scale or suffix
-          scale = 0
-          ' '
-        end
-        "%10.3f#{suffix}" % (value.to_f / (1000 ** scale))
+        scale = (Math.log10(value) / 3).to_i 
+        scale = 0 if scale < 0 || scale >= SUFFIXES.size
+        suffix = SUFFIXES[scale]
+        scaled_value = value.to_f / (1000 ** scale)
+    
+        "%10.3f#{suffix}" % scaled_value
       end
       module_function :scale
     end

data/lib/benchmark/timing.rb

@@ -1,5 +1,5 @@
 module Benchmark
-  # Perform caclulations on Timing results.
+  # Perform calculations on Timing results.
   module Timing
     # Microseconds per second.
     MICROSECONDS_PER_SECOND = 1_000_000

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-ips
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.13.0
 platform: ruby
 authors:
 - Evan Phoenix
@@ -59,9 +59,8 @@ files:
 - 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/job/multi_report.rb
+- lib/benchmark/ips/job/stream_report.rb
 - lib/benchmark/ips/report.rb
 - lib/benchmark/ips/share.rb
 - lib/benchmark/ips/stats/bootstrap.rb
@@ -89,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.20
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A iterations per second enhancement to Benchmark.

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

@@ -1,27 +0,0 @@
-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/noop_suite.rb

@@ -1,25 +0,0 @@
-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