benchmark_driver 0.14.22 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12ed79eb718a91c50643a0a4880810ffc2dd41e6fa2ee0553e24c631499cd262
-  data.tar.gz: 31a10ecb698c7911263db83ebe40ff27cfe790d768d2eacf454c60c2d0746408
+  metadata.gz: ccc06a22a6f3a22dd745264633e05acabc91a4696625f9e7958532e7de728f63
+  data.tar.gz: 8ba559f9a31adc785a65ae018aa4f552469570b08f3c679bc69e17429a1e50a4
 SHA512:
-  metadata.gz: 003d82d144d2cf0186af2ad9a548bdfe03a92bd2ea6765a6a1fc7258af1171ec6a2021a7a3f4c5d7c756c423dd653e973b3c02c9df63fe806016437c0c4fb53a
-  data.tar.gz: 15d64cb465a9e0830036a9f8998100a61d3822dde7353c40e54da7dd9c3ae898aba56d6f1fa340f5b9a40e5ff6b7e1f4267147af5ca1beaa57ecafb63ab468c8
+  metadata.gz: 04dcd4ad580bc8980c33469c2a3df0301c1fc272d8612246c02b095cfe37f46db13f787b678beafe3144869622c83ad91403036419e25b525aaa3e756d7f75c0
+  data.tar.gz: 43f9701dd9c6100fe9ec317f443bb09ab4410113b0b14acc1417ae0b748cd6b8abe9c2d26fedd4f365d2f67419c54311d774a4c6be4b37707d98861f7295ef19

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v0.15.0
+
+- Introduce output plugin interface to accept arbitrary `--output-xxx` option
+- Hide `--rbenv` option when `rbenv` command is not available
+
+# v0.14.22
+
+- Fix warnings for keyword arguments in Ruby 2.7
+
 # v0.14.21
 
 - Avoid crashinig on a zero division error in `compare` output

data/exe/benchmark-driver

@@ -20,6 +20,19 @@ config = BenchmarkDriver::Config.new.tap do |c|
     end
     o.on('-o', '--output TYPE', String, 'Specify output type: compare, simple, markdown, record (default: compare)') do |out|
       c.output_type = out
+      begin
+        plugin_options = BenchmarkDriver::Output.get(out).const_get('OPTIONS', false)
+      rescue ArgumentError, LoadError, NameError
+      else
+        plugin_options.each do |name, args|
+          unless args.first.start_with?('--output-')
+            raise ArgumentError.new("#{args.first.dump} must start with '--output-'")
+          end
+          o.on(*args) do |opt|
+            c.output_opts[name] = opt
+          end
+        end
+      end
     end
     o.on('-e', '--executables EXECS', String, 'Ruby executables (e1::path1 arg1; e2::path2 arg2;...)') do |e|
       e.split(';').each do |name_path|
@@ -34,7 +47,7 @@ config = BenchmarkDriver::Config.new.tap do |c|
       r.split(';').each do |version|
         executables << BenchmarkDriver::Rbenv.parse_spec(version)
       end
-    end
+    end if system('which rbenv > /dev/null')
     o.on('--repeat-count NUM', Integer, 'Try benchmark NUM times and use the fastest result or the worst memory usage') do |v|
       c.repeat_count = v
     end

data/lib/benchmark_driver/config.rb

@@ -6,6 +6,7 @@ module BenchmarkDriver
   Config = ::BenchmarkDriver::Struct.new(
     :runner_type,   # @param [String]
     :output_type,   # @param [String]
+    :output_opts,   # @param [Hash{ Symbol => Object }]
     :paths,         # @param [Array<String>]
     :executables,   # @param [Array<BenchmarkDriver::Config::Executable>]
     :filters,       # @param [Array<Regexp>]
@@ -17,6 +18,7 @@ module BenchmarkDriver
     defaults: {
       runner_type: 'ips',
       output_type: 'compare',
+      output_opts: {},
       filters: [],
       repeat_count: 1,
       repeat_result: 'best',

data/lib/benchmark_driver/output.rb

@@ -20,6 +20,17 @@ module BenchmarkDriver
     require 'benchmark_driver/output/record'
     require 'benchmark_driver/output/simple'
 
+    # @param [String] type
+    def self.get(type)
+      if type.include?(':')
+        raise ArgumentError.new("Output type '#{type}' cannot contain ':'")
+      end
+
+      require "benchmark_driver/output/#{type}" # for plugin
+      camelized = type.split('_').map(&:capitalize).join
+      ::BenchmarkDriver::Output.const_get(camelized, false)
+    end
+
     # BenchmarkDriver::Output is pluggable.
     # Create `BenchmarkDriver::Output::Foo` as benchmark_dirver-output-foo.gem and specify `-o foo`.
     #
@@ -27,18 +38,24 @@ module BenchmarkDriver
     # @param [Array<BenchmarkDriver::Metric>] metrics
     # @param [Array<BenchmarkDriver::Job>] jobs
     # @param [Array<BenchmarkDriver::Context>] contexts
-    def initialize(type:, metrics:, jobs:, contexts:)
-      if type.include?(':')
-        raise ArgumentError.new("Output type '#{type}' cannot contain ':'")
-      end
+    # @param [Hash{ Symbol => Object }] options
+    def initialize(type:, metrics:, jobs:, contexts:, options:)
+      output = ::BenchmarkDriver::Output.get(type)
+      output_params = output.instance_method(:initialize).parameters.select do |type, _name|
+        type == :keyreq || type == :key
+      end.map(&:last)
 
-      require "benchmark_driver/output/#{type}" # for plugin
-      camelized = type.split('_').map(&:capitalize).join
+      # Optionally pass `options` to #initialize
+      kwargs = {}
+      if output_params.include?(:options)
+        kwargs[:options] = options
+      end
 
-      @output = ::BenchmarkDriver::Output.const_get(camelized, false).new(
+      @output = output.new(
         metrics: metrics,
         jobs: jobs,
         contexts: contexts,
+        **kwargs,
       )
     end
 

data/lib/benchmark_driver/output/all.rb

@@ -2,14 +2,19 @@ class BenchmarkDriver::Output::All
   NAME_LENGTH = 20
   CONTEXT_LENGTH = 20
 
+  OPTIONS = {
+    sort: ['--output-sort true|false', TrueClass, 'Sort all output or not (default: true)'],
+  }
+
   # @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
     @job_names = jobs.map(&:name)
     @context_names = contexts.map(&:name)
     @name_length = [@job_names.map(&:length).max, NAME_LENGTH].max
+    @sort = options.fetch(:sort, true)
   end
 
   def with_warmup(&block)
@@ -67,7 +72,10 @@ class BenchmarkDriver::Output::All
     else
       print("\e[#{num_values}F")
     end
-    @context_values[@context] = result.all_values.values.first.sort
+    @context_values[@context] = result.all_values.values.first
+    if @sort
+      @context_values[@context] = @context_values[@context].sort
+    end
 
     precision = result.values.values.first.to_s.sub(/\A\d+\./, '').length
     num_values.times do |i|

data/lib/benchmark_driver/runner.rb

@@ -36,6 +36,7 @@ module BenchmarkDriver
               metrics: metrics,
               jobs: klass_jobs.map { |job| BenchmarkDriver::Job.new(name: job.name) },
               contexts: contexts,
+              options: config.output_opts,
             )
             with_clean_env do
               runner.new(config: runner_config, output: output, contexts: contexts).run(klass_jobs)

data/lib/benchmark_driver/version.rb

@@ -1,3 +1,3 @@
 module BenchmarkDriver
-  VERSION = '0.14.22'
+  VERSION = '0.15.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benchmark_driver
 version: !ruby/object:Gem::Version
-  version: 0.14.22
+  version: 0.15.0
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-01 00:00:00.000000000 Z
+date: 2019-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Fully-featured accurate benchmark driver for Ruby