benchmark_driver 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c1f7fc0a8d066c0e6fec248737f0a6a0b62cd84b15ed40121f56817a9c6322a
-  data.tar.gz: 95c7c9a3c4a847ac77592c4cd3dbb0a3f2068e83de442bd8184e999dda9979a9
+  metadata.gz: 064e5f572aa0e93b89cf6fd8fc0b0b60b853b96e8123879c2f8d4d15ee49d988
+  data.tar.gz: 1adf2bc7584828029a8bba49ce275750581838758318e498e6650e3e118880ac
 SHA512:
-  metadata.gz: c0b0e1be74c8e7a8a7b849828daffd6e586a84c3d2a188c1a84882a40ec83ca7717fc66c62d3d723d53b184e582b01cdc14ca74384c3cdfb93e2b80693593706
-  data.tar.gz: b4343234565046d92eb320eb3b5c9ffb7a73560ea9906cd7d541e7f9d065080fecc73f8d6542555abfe95a57e7438e797109acd5412ae6654b0c92631c3a2034
+  metadata.gz: d67e0b7d012111ad3c5db355072d0fb4eed1788699049a700568f4c5e9218bc73487041fb7a4ca825527a6a3859ca1e4117e7bf4a04d2ef484998f7aa57ebf2b
+  data.tar.gz: 9d59155a1f95066cf629ca9a55e91334cd0cf54214ca88f2267501469f75cd18b30b8e3bf56e9ac58b2b68b288d7f0ff4b4bc4f643a6a7cac1ebfe2b1004cd8e

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.7.1
+
+- Add `x.rbenv` to Ruby interface
+- Add `x.bundler` to Ruby interface
+
 # v0.7.0
 
 - Change Ruby interface for specifying prelude and script

data/README.md

@@ -4,22 +4,20 @@ Fully-featured accurate benchmark driver for Ruby
 
 ## Project Status
 
-**Under Construction**
+Beta. Features are almost implemented but interface may change in the future.
 
 ## Features
-NOTE: Pending ones are ~slashed~.
-
 ### Accurate Measurement
 
 - Low overhead benchmark by running generated script instead of calling Proc
 - Running multiple times to minimize measurement errors
-- Profiling memory, high-precision real time, ~user time and system time~
+- Profiling memory, high-precision real time
 
 ### Pluggable & Fully Featured
 
-- Flexible and real-time output format in ips, execution time, ~markdown table~, etc.
+- Flexible and real-time output format in ips, execution time, markdown table, etc.
 - Runner and output are all pluggable
-- ~Integrated benchmark support using external libraries~
+- Bundler integration for benchmark that requires gems
 
 ### Flexible Interface
 
@@ -151,19 +149,6 @@ Comparison:
   str-interp (2.4.2):   4305563.1 i/s - 1.40x  slower
 ```
 
-## TODO
-### Runner
-- [x] Call
-- [x] Exec
-- [ ] Eval
-
-### Output
-- [x] IPS
-- [x] Time
-- [ ] CPU/System/Real Time
-- [ ] Memory
-- [ ] Markdown Table
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/k0kubun/benchmark_driver.

data/exe/benchmark-driver

@@ -2,7 +2,6 @@
 $:.unshift File.expand_path('../lib', __dir__)
 
 require 'benchmark/driver'
-require 'benchmark/driver/bundle_installer'
 require 'benchmark/driver/yaml_parser'
 require 'optparse'
 require 'yaml'
@@ -17,18 +16,14 @@ parser = OptionParser.new do |o|
     abort '-e, --executable must take argument but not given' if e.nil?
     options[:execs] ||= []
     e.split(';').each do |name_path|
-      name, path = name_path.split('::', 2)
-      options[:execs] << Benchmark::Driver::Configuration::Executable.new(name, path ? path.split(',') : [name])
+      options[:execs] << Benchmark::Driver::Configuration::Executable.parse(name_path)
     end
   end
   o.on('--rbenv [VERSIONS]', 'Ruby executables in rbenv (x.x.x,arg1,...;y.y.y,arg2,...;...)') do |r|
     abort '--rbenv must take argument but not given' if r.nil?
     options[:execs] ||= []
     r.split(';').each do |spec|
-      version, *args = spec.split(',')
-      path = `RBENV_VERSION='#{version}' rbenv which ruby`.rstrip
-      abort "Failed to execute 'rbenv which ruby'" unless $?.success?
-      options[:execs] << Benchmark::Driver::Configuration::Executable.new(version, [path, *args])
+      options[:execs] << Benchmark::Driver::Configuration::Executable.parse_rbenv(spec)
     end
   end
   o.on('-o', '--output [TYPE]', 'Specify output type (ips, time, memory, markdown)') do |t|
@@ -82,21 +77,13 @@ end
 # Proceed parsed options
 #
 config = Benchmark::Driver::Configuration.new(jobs)
-config.runner_options = Benchmark::Driver::Configuration::RunnerOptions.new(:exec)
+config.runner_options = Benchmark::Driver::Configuration::RunnerOptions.new
 config.output_options = Benchmark::Driver::Configuration::OutputOptions.new(:ips)
 
-if options.key?(:execs)
-  # Proceed execs first for --bundler
-  config.runner_options.executables = options.delete(:execs)
-end
-
 options.each do |key, value|
   case key
   when :bundler
-    config.runner_options.executables.each do |executable|
-      Benchmark::Driver::BundleInstaller.bundle_install_for(executable)
-      executable.command << '-rbundler/setup'
-    end
+    config.runner_options.bundler = value
   when :compare
     config.output_options.compare = value
   when :dir
@@ -104,6 +91,8 @@ options.each do |key, value|
     config.jobs.each do |job|
       job.prelude = "__dir__ = #{dir.dump}.freeze; #{job.prelude}"
     end
+  when :execs
+    config.runner_options.executables = options.delete(:execs)
   when :filter
     filter = Regexp.compile(value)
     config.jobs.select! do |job|

data/lib/benchmark/driver.rb

@@ -19,6 +19,13 @@ module Benchmark
           config.runner_options.type = runner_type_for(config)
         end
 
+        if config.runner_options.bundler
+          config.runner_options.executables.each do |executable|
+            Benchmark::Driver::BundleInstaller.bundle_install_for(executable)
+            executable.command << '-rbundler/setup'
+          end
+        end
+
         runner_class = Runner.find(config.runner_options.type)
         output_class = Output.find(config.output_options.type)
 
@@ -88,6 +95,7 @@ end
 
 require 'benchmark/output'
 require 'benchmark/runner'
+require 'benchmark/driver/bundle_installer'
 require 'benchmark/driver/error'
 require 'benchmark/driver/ruby_dsl_parser'
 require 'benchmark/driver/version'

data/lib/benchmark/driver/configuration.rb

@@ -6,7 +6,7 @@ class Benchmark::Driver::Configuration < Struct.new(:jobs, :runner_options, :out
   # @param [String,Proc] sctipt
   # @param [String,nil] prelude
   # @param [Integer,nil] loop_count - If this is nil, loop count is automatically estimated by warmup.
-  class Job < Struct.new(:name, :script, :prelude, :loop_count)
+  Job = Struct.new(:name, :script, :prelude, :loop_count) do
     # @param [Integer,nil] guessed_count - Set by runner only when loop_count is nil. This is not configuration.
     attr_accessor :guessed_count
 
@@ -16,20 +16,32 @@ class Benchmark::Driver::Configuration < Struct.new(:jobs, :runner_options, :out
     end
 
     def loop_count
-      super || guessed_count
+      self[:loop_count] || guessed_count
     end
   end
 
   # @param [String] name
   # @param [Array<String>] command - ["ruby", "-w", ...]. First element should be path to ruby command
-  Executable = Struct.new(:name, :command)
+  Executable = Struct.new(:name, :command) do
+    def self.parse(name_path)
+      name, path = name_path.split('::', 2)
+      Benchmark::Driver::Configuration::Executable.new(name, path ? path.split(',') : [name])
+    end
+
+    def self.parse_rbenv(spec)
+      version, *args = spec.split(',')
+      path = `RBENV_VERSION='#{version}' rbenv which ruby`.rstrip
+      abort "Failed to execute 'rbenv which ruby'" unless $?.success?
+      Benchmark::Driver::Configuration::Executable.new(version, [path, *args])
+    end
+  end
 
   DEFAULT_EXECUTABLES = [Executable.new(RUBY_VERSION, [RbConfig.ruby])]
 
   # @param [Symbol] type - Type of runner
   # @param [Array<Benchmark::Driver::Configuration::Executable>] executables
   # @param [Integer,nil] repeat_count - Times to repeat benchmarks. When this is not nil, benchmark_driver will use the best result.
-  class RunnerOptions < Struct.new(:type, :executables, :repeat_count)
+  RunnerOptions = Struct.new(:type, :executables, :repeat_count, :bundler) do
     def initialize(*)
       super
       self.executables ||= DEFAULT_EXECUTABLES

data/lib/benchmark/driver/ruby_dsl_parser.rb

@@ -6,8 +6,11 @@ class Benchmark::Driver::RubyDslParser
   def initialize(runner: nil, output: :ips)
     @prelude = nil
     @jobs = []
-    @runner_options = Benchmark::Driver::Configuration::RunnerOptions.new(runner)
-    @output_options = Benchmark::Driver::Configuration::OutputOptions.new(output)
+    @runner = runner
+    @execs = []
+    @bundler = false
+    @output = :ips
+    @compare = false
   end
 
   # API to fetch configuration parsed from DSL
@@ -17,8 +20,8 @@ class Benchmark::Driver::RubyDslParser
       job.prelude = @prelude
     end
     Benchmark::Driver::Configuration.new(@jobs).tap do |c|
-      c.runner_options = @runner_options
-      c.output_options = @output_options
+      c.runner_options = Benchmark::Driver::Configuration::RunnerOptions.new(@runner, @execs, nil, @bundler)
+      c.output_options = Benchmark::Driver::Configuration::OutputOptions.new(@output, @compare)
     end
   end
 
@@ -34,6 +37,17 @@ class Benchmark::Driver::RubyDslParser
     @prelude = prelude_script
   end
 
+  # @param [Array<String>] specs
+  def rbenv(*specs)
+    specs.each do |spec|
+      @execs << Benchmark::Driver::Configuration::Executable.parse_rbenv(spec)
+    end
+  end
+
+  def bundler
+    @bundler = true
+  end
+
   # @param [String,nil] name   - Name shown on result output. This must be provided if block is given.
   # @param [String,nil] script - Benchmarked script in String. Only either of script or block must be provided.
   # @param [Proc,nil]   block  - Benchmarked Proc object.
@@ -52,6 +66,6 @@ class Benchmark::Driver::RubyDslParser
   end
 
   def compare!
-    @output_options.compare = true
+    @compare = true
   end
 end

data/lib/benchmark/driver/version.rb

@@ -1,5 +1,5 @@
 module Benchmark
   module Driver
-    VERSION = '0.7.0'
+    VERSION = '0.7.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: benchmark_driver
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Takashi Kokubun