benchmark_driver 0.15.11 → 0.15.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c0053583af2abfde832055eff70cefad2490bfc964fecec491bfcf31c6f0770
-  data.tar.gz: d418a089c5a83abc8ee92f34e522c5119edcaa4a8077739f331e5d0b2f13d12f
+  metadata.gz: 4c069979523cfd025fba37653a117db89a52062bfedd7fe3d2c8b8ef5eaab329
+  data.tar.gz: 23f32d6a140120ccbddd2ce704590cde72496fc0e7834674fecc865d04e8c943
 SHA512:
-  metadata.gz: c7849db1545aa8c304afa85f6d760335eda341a3e23374b6182e992a6e269a3b42fea0159abb34b070c8bbe342d1cebd300b154c155cce427eedbabf365b3ad8
-  data.tar.gz: eb9f938aa863981a1d90e7f5b6b0c8bd103c70e5fbae7a859c84868ee4f1782c1f93db7f8b87273da138acbd642ba54f41b2e81e89f1f96fc971eef971ab57b1
+  metadata.gz: d9d9a2cde658660d21dcf36a2ff872ac42c7a518aaf2a917744eacbcf8e2e95814ded6edb140a3b9d23273291850a2948cc47c09297d5b973b531da3a2582fd5
+  data.tar.gz: 48a7c466c98a4304c3cc44bcfc7adf2d277c546e226cb3082999a1a384f038f969c7782b338b851bafd9c319d2d1aad4adca243b1c358346a2b79c1ca0ac0c78

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.15.12
+
+- Show comparison on `--output=markdown` when `--output-compare` is also specified
+
 # v0.15.11
 
 - Correctly calculate an average result on `--repeat-result=average`

data/lib/benchmark_driver/output/compare.rb

@@ -117,17 +117,17 @@ class BenchmarkDriver::Output::Compare
 
   def humanize(value, width = 10)
     if BenchmarkDriver::Result::ERROR.equal?(value)
-      return " %#{width}s" % 'ERROR'
+      return sprintf(" %*s", width, 'ERROR')
     elsif value == 0.0
-      return " %#{width}.3f" % 0.0
+      return sprintf(" %*.3f", width, 0.0)
     elsif value < 0
       raise ArgumentError.new("Negative value: #{value.inspect}")
     end
 
     scale = (Math.log10(value) / 3).to_i
-    return "%#{width}s" % value.to_s if scale < 0 # like 1.23e-04
+    return sprintf("%*s", width, value.to_s) if scale < 0 # like 1.23e-04
 
-    prefix = "%#{width}.3f" % (value.to_f / (1000 ** scale))
+    prefix = sprintf("%*.3f", width, (value.to_f / (1000 ** scale)))
     suffix =
       case scale
       when 1; 'k'
@@ -173,7 +173,7 @@ class BenchmarkDriver::Output::Compare
     $stdout.puts "\nComparison:"
 
     @job_context_result.each do |job, context_result|
-      $stdout.puts("%#{@name_length + 2 + 11}s" % job)
+      $stdout.printf("%*s\n", @name_length + 2 + 11, job)
       results = context_result.flat_map do |context, result|
         result.values.values.map { |value| Result.new(job: job, value: value, context: context) }
       end
@@ -188,7 +188,7 @@ class BenchmarkDriver::Output::Compare
 
     unless BenchmarkDriver::Result::ERROR.equal?(bottom)
       ratio = top / bottom
-      "- %.2fx  #{@metrics.first.worse_word}" % ratio
+      sprintf("- %.2fx  %s", ratio, @metrics.first.worse_word)
     end
   end
 
@@ -211,7 +211,7 @@ class BenchmarkDriver::Output::Compare
       else
         name = result.job
       end
-      $stdout.puts("%#{@name_length}s: %11.1f %s #{slower}" % [name, result.value, @metrics.first.unit])
+      $stdout.printf("%*s: %11.1f %s %s\n", @name_length, name, result.value, @metrics.first.unit, slower)
     end
     $stdout.puts
   end

data/lib/benchmark_driver/output/markdown.rb

@@ -1,13 +1,19 @@
 class BenchmarkDriver::Output::Markdown
   NAME_LENGTH = 8
 
+  OPTIONS = {
+    compare: ['--output-compare', 'Show comparison between results'],
+  }
+
   # @param [Array<BenchmarkDriver::Metric>] metrics
   # @param [Array<BenchmarkDriver::Job>] jobs
   # @param [Array<BenchmarkDriver::Context>] contexts
-  def initialize(metrics:, jobs:, contexts:)
+  def initialize(metrics:, jobs:, contexts:, options:)
     @metrics = metrics
+    @contexts = contexts
     @context_names = contexts.map(&:name)
     @name_length = jobs.map(&:name).map(&:size).max
+    @compare = options.fetch(:compare, false)
   end
 
   def with_warmup(&block)
@@ -28,14 +34,15 @@ class BenchmarkDriver::Output::Markdown
       # Show executable names
       $stdout.print("|#{' ' * @name_length}  ")
       @context_names.each do |context_name|
-        $stdout.print("|%#{NAME_LENGTH}s" % context_name) # same size as humanize
+        $stdout.printf("|%*s", NAME_LENGTH, context_name) # same size as humanize
       end
       $stdout.puts('|')
 
       # Show header separator
       $stdout.print("|:#{'-' * (@name_length - 1)}--")
       @context_names.each do |context_name|
-        $stdout.print("|#{'-' * (NAME_LENGTH - 1)}:") # same size as humanize
+        length = [context_name.length, NAME_LENGTH].max
+        $stdout.print("|#{'-' * (length - 1)}:") # same size as humanize
       end
       $stdout.puts('|')
 
@@ -48,24 +55,33 @@ class BenchmarkDriver::Output::Markdown
   # @param [BenchmarkDriver::Job] job
   def with_job(job, &block)
     if @with_benchmark
-      $stdout.print("|%-#{@name_length}s  " % job.name)
+      @job_context_result = {} if @context_names.size > 1
+
+      $stdout.printf("|%-*s  ", @name_length, job.name)
     end
     block.call
   ensure
     if @with_benchmark
       $stdout.puts('|')
+      compare_executables if @compare && @context_names.size > 1
     end
   end
 
   # @param [BenchmarkDriver::Context] context
   def with_context(context, &block)
+    @context = context
     block.call
   end
 
   # @param [BenchmarkDriver::Result] result
   def report(result)
+    if defined?(@job_context_result)
+      @job_context_result[@context] = result
+    end
+
     if @with_benchmark
-      $stdout.print("|%#{NAME_LENGTH}s" % humanize(result.values.fetch(@metrics.first)))
+      length = [NAME_LENGTH, @context.name.length].max
+      $stdout.printf("|%*s", length, humanize(result.values.fetch(@metrics.first)))
     else
       $stdout.print '.'
     end
@@ -83,15 +99,15 @@ class BenchmarkDriver::Output::Markdown
 
   def humanize(value)
     if BenchmarkDriver::Result::ERROR.equal?(value)
-      return "%#{NAME_LENGTH}s" % 'ERROR'
+      return sprintf("%*s", NAME_LENGTH, 'ERROR')
     elsif value == 0.0
-      return "%#{NAME_LENGTH}.3f" % 0.0
+      return sprintf("%*.3f", NAME_LENGTH, 0.0)
     elsif value < 0
       raise ArgumentError.new("Negative value: #{value.inspect}")
     end
 
     scale = (Math.log10(value) / 3).to_i
-    prefix = "%#{NAME_LENGTH - 1}.3f" % (value.to_f / (1000 ** scale))
+    prefix = sprintf("%*.3f", NAME_LENGTH - 1, (value.to_f / (1000 ** scale)))
     suffix =
       case scale
       when 1; 'k'
@@ -104,4 +120,30 @@ class BenchmarkDriver::Output::Markdown
       end
     "#{prefix}#{suffix}"
   end
+
+  def compare_executables
+    order = @metrics.first.larger_better ? :min_by : :max_by
+    worst, worst_result = @job_context_result.__send__(order) do |_, result|
+      result.values.first[1]
+    end
+    worst_result = worst_result.values.first[1]
+    $stdout.print("|", " " * (@name_length + 2))
+    @job_context_result.each do |context, result|
+      if context == worst
+        result = '-'
+      else
+        result = result.values.first[1]
+        if order == :min_by
+          result = result.fdiv(worst_result)
+        else
+          result = best_result.fdiv(worst_result)
+        end
+        result = sprintf("%.2fx", result)
+      end
+      length = [context.name.length, NAME_LENGTH].max
+      $stdout.printf("|%*s", length, result)
+    end
+    $stdout.puts('|')
+  end
+
 end

data/lib/benchmark_driver/version.rb

@@ -1,3 +1,3 @@
 module BenchmarkDriver
-  VERSION = '0.15.11'
+  VERSION = '0.15.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benchmark_driver
 version: !ruby/object:Gem::Version
-  version: 0.15.11
+  version: 0.15.12
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2020-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.0.pre1
+rubygems_version: 3.2.0.pre1
 signing_key: 
 specification_version: 4
 summary: Fully-featured accurate benchmark driver for Ruby