benchmark_driver 0.10.12 → 0.10.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8476feea0b9fe972915f9cf0ca928cbdc34321e477f042c239965a9e41db2560
-  data.tar.gz: 5004f72484e4c00318043d9947f50f7dfdd4f4cbb2ddd27e2f48809c7b9d165a
+  metadata.gz: 888668b113284dcb442c1d9bfb4fc37563b1b73b26bd93c21d6b823e0dcace4e
+  data.tar.gz: 92413919e8a9959fa88137da71cda69a5941bec2988b71fc365d47f08d254b57
 SHA512:
-  metadata.gz: c8950a06fc9c5f894c6a4b11125b19b3ffe81fa1c483c0300605fd5e22ca8b7688d58bb97427b873db15759323f0617863640383a26a45efe4982948e595ddb9
-  data.tar.gz: c64f920ef9bb625c6ee82980d4b889c78695a211a4ae5ca5d41728e9597cdda5b2130995dbca854edfab858559896dbb8c6fdbe7ba847bff1620fa21a99c91ab
+  metadata.gz: e16d5a6c38b9145778e08f045a7022b8b5d648f9f8b66afafa32158fd8bf52ab9c9f2fe7e895ae4fbbbf7ff977fdb7a57b592e6e4e150de1fc256b6cd8fdc446
+  data.tar.gz: 88055b5b9ef159b75540c62b47eb54bf78316e9174e4f7ef9a3e1768fe0151f6a067814cff4b150cf2fa102d309741793d3c72f9c8e0f7b95c2502052b1f7d30

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.10.13
+
+- Add `x.output` to specify output plugin to Ruby interface
+  - You can still use `Benchmark.driver(output: xxx)` form too
+
 # v0.10.12
 
 - Fix some typo in help

data/README.md

@@ -2,29 +2,23 @@
 
 Fully-featured accurate benchmark driver for Ruby
 
-## Project Status
-
-Beta.
-
-Interface might be changed in the future, but it's almost fixed and many features can run well.
-
 ## Features
 ### Accurate Measurement
 
 - Low overhead benchmark by running generated script instead of calling Proc
-- Profiling memory, high-precision real time, user time and system time
+- Profiling memory and high-precision real time
 - Running multiple times to minimize measurement errors
 
 ### Pluggable & Fully Featured
 
-- Flexible and real-time output format in ips, execution time, markdown table, etc.
-- Benchmark with various running options
+- Flexible and real-time output format in comparison, markdown table, graph, etc.
+- Measuring various metrics by specifying runners
 - Integrated benchmark support using external libraries
 - Runner and output format are all pluggable
 
 ### Flexible Interface
 
-- Ruby interface similar to benchmark stdlib, benchmark-ips
+- Ruby interface similar to stdlib benchmark.rb, benchmark-ips
 - YAML input to easily manage structured benchmark set
 - Comparing multiple Ruby binaries, even with miniruby
 
@@ -151,6 +145,27 @@ Comparison:
                2.4.1:   1889805.6 i/s - 1.72x  slower
 ```
 
+## Output options
+
+By default, there are following output options.
+
+* compare: benchmark-ips's `compare!`-like output (default)
+* simple: ruby's original `benchmark/driver.rb`-like simple output
+* markdown: output in markdown table
+* record: serialize results in `benchmark_driver.record.yml`, to change outputs later as you like
+
+With `benchmark-driver` CLI, you can specify it with `-o [output]` or `--output [output]`.
+
+With Ruby interface, you can specify it like:
+
+```rb
+Benchmark.driver do |x|
+  x.prelude %{ array = [] }
+  x.report 'Array#empty?', %{ array.empty? }
+  x.output 'markdown'
+end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/k0kubun/benchmark_driver.

data/examples/exec_blank.rb

@@ -9,5 +9,5 @@ Benchmark.driver do |x|
   EOS
   x.report 'Array#empty?', %{ array.empty? }
   x.report 'Array#blank?', %{ array.blank? }
-  x.compare!
+  x.output 'markdown'
 end

data/lib/benchmark_driver/ruby_interface.rb

@@ -55,6 +55,10 @@ module BenchmarkDriver
       @jobs << { benchmark: [{ name: name, script: script }] }
     end
 
+    def output(type)
+      @config.output_type = type
+    end
+
     # Backward compatibility. This is actually default now.
     def compare!
       @config.output_type = 'compare'

data/lib/benchmark_driver/version.rb

@@ -1,3 +1,3 @@
 module BenchmarkDriver
-  VERSION = '0.10.12'
+  VERSION = '0.10.13'
 end

metadata

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