benchmark-ips 2.10.0 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0516f3e1e35f43a8fe32a6f32357aa124478ba54228ffe57d928cfc1231851bc
-  data.tar.gz: d62da6a6c1d2696b7667bd125ffe6bb2c33b3d61da5c393e729d7ca8a3d70ee7
+  metadata.gz: f5c89b6607d6960de72e63e6e14ee0283f2dbe3f2418f33d90b57e947f555d70
+  data.tar.gz: 5ee11f5ae33b1c426a90deba5799a739cd13d785d5ab7c4e4ffaa942d5ddc8db
 SHA512:
-  metadata.gz: b644d293980f1ac9e3158abbe4f2c9d44d23185878edb9cb3861f3ca4f6837d557f89f8eb19bfcc42a45f53f3d112f2fe3ab22fc85a9633ede7e678b5fb90336
-  data.tar.gz: afe9972cdecdb2f42d4946afbac3d02cb3ead3a3d47a804960026ea77487cf885f6ddd7368edb13c522ee11e251599bf953d3d9a8172411c10e7259f7e9352b2
+  metadata.gz: 52e1d308de07129514ff4c6c9848a0e68f074937ab2cd05b75060ac055655bc581f382041ddd21780439f682540fdb3ee5d041214a677dc87cd8a527b587bfe8
+  data.tar.gz: fbb5b4045f318f31772eb3e27cc6f49c1589d857d13c17d7e16c52d82be5253aef30b7c327f8f76f9e14cc3c81bd496423f1f043e8cd7287074a31466bd49b07

data/History.md

@@ -1,3 +1,13 @@
+### 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
+  * Adds .json! method to the ips block argument, allowing you to print the output as JSON to a file or STDOUT.
+
 ### 2.10.0 / 2022-02-17
 
 * Feature

data/README.md

@@ -237,6 +237,29 @@ Benchmark.ips do |x|
 end
 ```
 
+### Output as JSON
+
+You can generate output in JSON. If you want to write JSON to a file, pass filename to `json!` method:
+
+```ruby
+Benchmark.ips do |x|
+  x.report("some report") {  }
+  x.json! 'filename.json'
+end
+```
+
+If you want to write JSON to STDOUT, pass `STDOUT` to `json!` method and set `quiet = true` before `json!`:
+
+```ruby
+Benchmark.ips do |x|
+  x.report("some report") {  }
+  x.quiet = true
+  x.json! STDOUT
+end
+```
+
+This is useful when the output from `benchmark-ips` becomes an input of other tools via stdin.
+
 ## REQUIREMENTS:
 
 * None!

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,44 @@
 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 "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/report.rb

@@ -183,9 +183,13 @@ module Benchmark
       # Generate json from Report#data to given path.
       # @param path [String] path to generate json.
       def generate_json(path)
-        File.open path, "w" do |f|
-          require "json"
-          f.write JSON.pretty_generate(data)
+        require "json"
+        if path.respond_to?(:write) # STDOUT
+          path.write JSON.pretty_generate(data)
+        else
+          File.open path, "w" do |f|
+            f.write JSON.pretty_generate(data)
+          end
         end
       end
     end

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

@@ -24,9 +24,9 @@ module Benchmark
         # @returns [Array<Float, nil>] the slowdown and the error (not calculated for standard deviation)
         def slowdown(baseline)
           if baseline.central_tendency > central_tendency
-            [baseline.central_tendency.to_f / central_tendency, 0]
+            [baseline.central_tendency.to_f / central_tendency, nil]
           else
-            [central_tendency.to_f / baseline.central_tendency, 0]
+            [central_tendency.to_f / baseline.central_tendency, nil]
           end
         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.10.0"
+    VERSION = "2.12.0"
 
     # CODENAME of current version.
-    CODENAME = "Watashi Wa Genki"
+    CODENAME = "Long Awaited"
 
     # Measure code in block, each code's benchmarked result will display in
     # iteration per second with standard deviation in given time.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-ips
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.12.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.2.26
+rubygems_version: 3.3.20
 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