lib/benchmark_driver/output/markdown.rb in benchmark_driver-0.15.11 vs lib/benchmark_driver/output/markdown.rb in benchmark_driver-0.15.12

@@ -1,15 +1,21 @@
 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)
     without_stdout_buffering do
       $stdout.print 'warming up'
@@ -26,18 +32,19 @@
       $stdout.puts "# #{@metrics.first.name} (#{@metrics.first.unit})\n\n"
 
       # 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('|')
 
       block.call
     end
@@ -46,28 +53,37 @@
   end
 
   # @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
   end
 
@@ -81,19 +97,19 @@
     $stdout.sync = sync
   end
 
   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'
       when 2; 'M'
       when 3; 'G'
@@ -102,6 +118,32 @@
       else # < 1000 or > 10^15, no scale or suffix
         return " #{prefix}"
       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