benchmark_driver 0.8.6 → 0.9.0

data/lib/benchmark_driver/runner/time.rb

@@ -0,0 +1,18 @@
+require 'benchmark_driver/runner/ips'
+
+class BenchmarkDriver::Runner::Time < BenchmarkDriver::Runner::Ips
+  # JobParser returns this, `BenchmarkDriver::Runner.runner_for` searches "*::Job"
+  Job = Class.new(BenchmarkDriver::DefaultJob)
+  # Dynamically fetched and used by `BenchmarkDriver::JobParser.parse`
+  JobParser = BenchmarkDriver::DefaultJobParser.for(Job)
+  # Passed to `output` by `BenchmarkDriver::Runner.run`
+  MetricsType = BenchmarkDriver::Metrics::Type.new(unit: 's')
+
+  # Overriding BenchmarkDriver::Runner::Ips#build_metrics
+  def build_metrics(duration:, executable:, loop_count:)
+    BenchmarkDriver::Metrics.new(
+      value: duration,
+      executable: executable,
+    )
+  end
+end

data/lib/benchmark_driver/struct.rb

@@ -0,0 +1,85 @@
+# Extended Struct with:
+#   * Polyfilled `keyword_init: true`
+#   * Default value configuration
+#   * Deeply freezing members
+module BenchmarkDriver
+  class << Struct = Module.new
+    # @param [Array<Symbol>] args
+    # @param [Hash{ Symbol => Object }] defaults
+    def new(*args, defaults: {}, &block)
+      # Polyfill `keyword_init: true`
+      if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
+        klass = ::Struct.new(*args, keyword_init: true, &block)
+      else
+        klass = keyword_init_struct(*args, &block)
+      end
+
+      # Default value config
+      configure_defaults(klass, defaults)
+
+      # Force deeply freezing members
+      force_deep_freeze(klass)
+
+      klass
+    end
+
+    private
+
+    # Polyfill for Ruby < 2.5.0
+    def keyword_init_struct(*args, &block)
+      ::Struct.new(*args).tap do |klass|
+        klass.prepend(Module.new {
+          # @param [Hash{ Symbol => Object }] args
+          def initialize(**args)
+            args.each do |key, value|
+              unless members.include?(key)
+                raise ArgumentError.new("unknwon keywords: #{key}")
+                next
+              end
+
+              public_send("#{key}=", value)
+            end
+          end
+        })
+        klass.prepend(Module.new(&block))
+      end
+    end
+
+    def configure_defaults(klass, defaults)
+      class << klass
+        attr_accessor :defaults
+      end
+      klass.defaults = defaults
+
+      klass.prepend(Module.new {
+        def initialize(**)
+          super
+          self.class.defaults.each do |key, value|
+            if public_send(key).nil?
+              public_send("#{key}=", value)
+            end
+          end
+        end
+      })
+
+      def klass.inherited(child)
+        child.defaults = self.defaults
+      end
+    end
+
+    def force_deep_freeze(klass)
+      klass.class_eval do
+        def freeze
+          members.each do |member|
+            value = public_send(member)
+            if value.is_a?(Array)
+              value.each(&:freeze)
+            end
+            value.freeze
+          end
+          super
+        end
+      end
+    end
+  end
+end

data/lib/benchmark_driver/version.rb

@@ -0,0 +1,3 @@
+module BenchmarkDriver
+  VERSION = '0.9.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benchmark_driver
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.9.0
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-28 00:00:00.000000000 Z
+date: 2018-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,16 +54,8 @@ files:
 - README.md
 - Rakefile
 - benchmark_driver.gemspec
-- bin/bench
 - bin/console
 - bin/setup
-- examples/call.rb
-- examples/call_blank.rb
-- examples/call_erb.rb
-- examples/call_interpolation.rb
-- examples/eval_blank.rb
-- examples/eval_blank_loop.rb
-- examples/eval_interpolation.rb
 - examples/exec_blank.rb
 - examples/exec_blank_simple.rb
 - examples/yaml/array_duration_time.yml
@@ -76,28 +68,24 @@ files:
 - examples/yaml/example_multi.yml
 - examples/yaml/example_single.yml
 - exe/benchmark-driver
-- lib/benchmark/driver.rb
-- lib/benchmark/driver/benchmark_result.rb
-- lib/benchmark/driver/bundle_installer.rb
-- lib/benchmark/driver/bundler.rb
-- lib/benchmark/driver/configuration.rb
-- lib/benchmark/driver/duration_runner.rb
-- lib/benchmark/driver/error.rb
-- lib/benchmark/driver/repeatable_runner.rb
-- lib/benchmark/driver/ruby_dsl_parser.rb
-- lib/benchmark/driver/time.rb
-- lib/benchmark/driver/version.rb
-- lib/benchmark/driver/yaml_parser.rb
-- lib/benchmark/output.rb
-- lib/benchmark/output/ips.rb
-- lib/benchmark/output/markdown.rb
-- lib/benchmark/output/memory.rb
-- lib/benchmark/output/time.rb
-- lib/benchmark/runner.rb
-- lib/benchmark/runner/call.rb
-- lib/benchmark/runner/eval.rb
-- lib/benchmark/runner/exec.rb
 - lib/benchmark_driver.rb
+- lib/benchmark_driver/config.rb
+- lib/benchmark_driver/default_job.rb
+- lib/benchmark_driver/default_job_parser.rb
+- lib/benchmark_driver/job_parser.rb
+- lib/benchmark_driver/metrics.rb
+- lib/benchmark_driver/output.rb
+- lib/benchmark_driver/output/compare.rb
+- lib/benchmark_driver/output/markdown.rb
+- lib/benchmark_driver/output/simple.rb
+- lib/benchmark_driver/rbenv.rb
+- lib/benchmark_driver/ruby_interface.rb
+- lib/benchmark_driver/runner.rb
+- lib/benchmark_driver/runner/ips.rb
+- lib/benchmark_driver/runner/memory.rb
+- lib/benchmark_driver/runner/time.rb
+- lib/benchmark_driver/struct.rb
+- lib/benchmark_driver/version.rb
 homepage: https://github.com/k0kubun/benchmark_driver
 licenses:
 - MIT
@@ -110,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -118,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Fully-featured accurate benchmark driver for Ruby

data/bin/bench

@@ -1,4 +0,0 @@
-#!/bin/bash
-exec bundle exec exe/benchmark-driver \
-  --compare \
-  $@

data/examples/call.rb

@@ -1,12 +0,0 @@
-require 'benchmark/driver'
-
-Benchmark.driver do |x|
-  large_a = "Hellooooooooooooooooooooooooooooooooooooooooooooooooooo"
-  large_b = "Wooooooooooooooooooooooooooooooooooooooooooooooooooorld"
-
-  small_a = "Hello"
-  small_b = "World"
-
-  x.report('large') { "#{large_a}, #{large_b}!" }
-  x.report('small') { "#{small_a}, #{small_b}!" }
-end

data/examples/call_blank.rb

@@ -1,13 +0,0 @@
-require 'benchmark/driver'
-
-class Array
-  alias_method :blank?, :empty?
-end
-
-Benchmark.driver(runner: :call) do |x|
-  array = []
-
-  x.report('array.empty?') { array.empty? }
-  x.report('array.blank?') { array.blank? }
-  x.compare!
-end

data/examples/call_erb.rb

@@ -1,33 +0,0 @@
-require 'benchmark/driver'
-require 'erb'
-require 'erubi'
-require 'erubis'
-
-data = DATA.read
-
-mod = Module.new
-mod.instance_eval("def self.erb(title, content); #{ERB.new(data).src}; end", "(ERB)")
-mod.instance_eval("def self.erubis(title, content); #{Erubi::Engine.new(data).src}; end", "(Erubi)")
-mod.instance_eval("def self.erubi(title, content); #{Erubis::Eruby.new(data).src}; end", "(Erubis)")
-
-title = "hello world!"
-content = "hello world!\n" * 10
-
-Benchmark.driver do |x|
-  x.report("ERB #{RUBY_VERSION}")       { mod.erb(title, content) }
-  x.report("Erubis #{Erubis::VERSION}") { mod.erubis(title, content) }
-  x.report("Erubi #{Erubi::VERSION}")   { mod.erubi(title, content) }
-  x.compare!
-end
-
-__END__
-
-<html>
-  <head> <%= title %> </head>
-  <body>
-    <h1> <%= title %> </h1>
-    <p>
-      <%= content %>
-    </p>
-  </body>
-</html>

data/examples/call_interpolation.rb

@@ -1,13 +0,0 @@
-require 'benchmark/driver'
-
-Benchmark.driver do |x|
-  large_a = "Hellooooooooooooooooooooooooooooooooooooooooooooooooooo"
-  large_b = "Wooooooooooooooooooooooooooooooooooooooooooooooooooorld"
-
-  small_a = "Hello"
-  small_b = "World"
-
-  x.report('large') { "#{large_a}, #{large_b}!" }
-  x.report('small') { "#{small_a}, #{small_b}!" }
-  x.compare!
-end

data/examples/eval_blank.rb

@@ -1,12 +0,0 @@
-require 'benchmark/driver'
-
-class Array
-  alias_method :blank?, :empty?
-end
-
-Benchmark.driver(runner: :eval) do |x|
-  x.prelude %{ array = [] }
-  x.report 'Array#empty?', %{ array.empty? }
-  x.report 'Array#blank?', %{ array.blank? }
-  x.compare!
-end

data/examples/eval_blank_loop.rb

@@ -1,13 +0,0 @@
-require 'benchmark/driver'
-
-class Array
-  alias_method :blank?, :empty?
-end
-
-Benchmark.driver do |x|
-  x.prelude %{ array = [] }
-  x.report 'Array#empty?', %{ array.empty? }
-  x.report 'Array#blank?', %{ array.blank? }
-  x.loop_count 10000000
-  x.compare!
-end

data/examples/eval_interpolation.rb

@@ -1,15 +0,0 @@
-require 'benchmark/driver'
-
-Benchmark.driver do |x|
-  x.prelude <<-EOS
-    large_a = "Hellooooooooooooooooooooooooooooooooooooooooooooooooooo"
-    large_b = "Wooooooooooooooooooooooooooooooooooooooooooooooooooorld"
-
-    small_a = "Hello"
-    small_b = "World"
-  EOS
-
-  x.report('large', '"#{large_a}, #{large_b}!"')
-  x.report('small', '"#{small_a}, #{small_b}!"')
-  x.compare!
-end

data/lib/benchmark/driver.rb

@@ -1,101 +0,0 @@
-module Benchmark
-  # RubyDriver entrypoint.
-  def self.driver(*args, &block)
-    dsl = Driver::RubyDslParser.new(*args)
-    block.call(dsl)
-
-    Driver.run(dsl.configuration)
-  end
-
-  module Driver
-    class InvalidConfig < StandardError; end
-
-    class << self
-      # Main function which is used by both RubyDriver and YamlDriver.
-      # @param [Benchmark::Driver::Configuration] config
-      def run(config)
-        validate_config(config)
-        if config.runner_options.type.nil?
-          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)
-
-        missing_fields = output_class::REQUIRED_FIELDS - runner_class::SUPPORTED_FIELDS
-        unless missing_fields.empty?
-          raise ArgumentError.new(
-            "#{output_class.name} requires #{missing_fields.inspect} fields "\
-            "which are not supported by #{runner_class.name}. Try using another runner."
-          )
-        end
-
-        without_stdout_buffering do
-          runner = runner_class.new(
-            config.runner_options,
-            output: output_class.new(
-              jobs:        config.jobs,
-              executables: config.runner_options.executables,
-              options:     config.output_options,
-            ),
-          )
-          runner.run(config)
-        end
-      rescue Benchmark::Driver::Error => e
-        $stderr.puts "\n\nFailed to execute benchmark!\n\n#{e.class.name}:\n  #{e.message}"
-        exit 1
-      end
-
-      private
-
-      def validate_config(config)
-        if config.jobs.empty?
-          raise InvalidConfig.new('No benchmark script is specified')
-        end
-
-        script_class = config.jobs.first.script.class
-        unless config.jobs.all? { |j| j.script.is_a?(script_class) }
-          raise InvalidConfig.new('Benchmark scripts include both String and Proc. Only either of them should be specified.')
-        end
-
-        # TODO: invalidate prelude for call runner
-      end
-
-      def runner_type_for(config)
-        script_class = config.jobs.first.script.class
-        if script_class == Proc
-          :call
-        elsif config.runner_options.executables_specified?
-          :exec
-        else
-          :eval
-        end
-      end
-
-      # benchmark_driver ouputs logs ASAP. This enables sync flag for it.
-      #
-      # Currently benchmark_driver supports only output to stdout.
-      # In future exetension, this may be included in Output plugins.
-      def without_stdout_buffering
-        sync, $stdout.sync = $stdout.sync, true
-        yield
-      ensure
-        $stdout.sync = sync
-      end
-    end
-  end
-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/benchmark_result.rb

@@ -1,21 +0,0 @@
-# @param [Benchmark::Driver::Configuration::Job] job
-# @param [Integer] iterations - Executed iterations of benchmark script in the job
-# @param [Float] real - Real time taken by the job
-# @param [Integer] max_rss - Maximum resident set size of the process during its lifetime, in Kilobytes.
-class Benchmark::Driver::BenchmarkResult < Struct.new(:job, :iterations, :real, :max_rss)
-  alias :duration :real
-
-  def ips
-    iterations / real
-  end
-
-  def ip100ms
-    ips / 10
-  end
-
-  def iterations
-    # runner's warmup uses `result.ips` to calculate `job.loop_count`, and thus
-    # at that moment `job.loop_count` isn't available and we need to use `super`.
-    super || job.loop_count
-  end
-end