benchmark-perf 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7fe9d604c0acf5ef3342b1bb0f7dc4e25c4842be28f2dcfccfa294afc1c7699
-  data.tar.gz: 9c99fac42b55347306729883c255e7976d7185e94ccf00fdf8985bbcdc40271c
+  metadata.gz: b9e96517aac61f030785b74eebd97e06e49e74eda0bb7ce37854ed454817a5f9
+  data.tar.gz: 82a06c6df41203a33abbe439fe30fc0df64a2a22c26e5ef730fcb065733e0dbd
 SHA512:
-  metadata.gz: cc1775bb46d926fd6c23df11c4c257ead8c5818b05814b34760f1500aa8226ede1e5f46d2be974d2303ba9b2749b58ab75714662ba13485230eaa334ab3d6693
-  data.tar.gz: 81a6b09450fbcd6bb61ac110cef837e163e8635734b59328c6c1ff06d251804e349de88efe03446ea43ceb8ee5960a19bb63d1f16c0a36e494cdedb819c16006
+  metadata.gz: b09c694ef8fe8d30f21407a0a16d3ce8a86ac139257a08876ad1cf2cce298d2dfccee5f2078e75ec2420985bcd8588383a442a9f1e1d85f52a17ea4889b50bb2
+  data.tar.gz: 4c4e308e46b4874bf656f15716500149a1d3daa869f330714c478bac1d50cb3b224cb6f2587a385d1adcc1545b45dd003020696a8468dec645d68e6531175c99

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change log
 
+## [v0.4.0] - 2018-09-30
+
+### Changed
+* Change ExecutionTime#run :times argument to :repeat
+* Change ExecutionTime#run to specify accepted values for :repeat argument
+* Change default measurements repeat time to be once
+
+### Fixed
+* Change ExecutionTime#run to correctly generate repeats range
+
 ## [v0.3.0] - 2018-09-16
 
 ### Added
@@ -40,6 +50,7 @@
 
 Initial release
 
+[v0.4.0]: https://github.com/piotrmurach/benchmark-perf/compare/v0.3.0...v0.4.0
 [v0.3.0]: https://github.com/piotrmurach/benchmark-perf/compare/v0.2.1...v0.3.0
 [v0.2.1]: https://github.com/piotrmurach/benchmark-perf/compare/v0.2.0...v0.2.1
 [v0.2.0]: https://github.com/piotrmurach/benchmark-perf/compare/v0.1.1...v0.2.0

data/README.md

@@ -59,10 +59,10 @@ mean, stddev, iter, elapsed_time = Benchmark::Perf::Iteration.run { ... }
 
 ### 2.1 Execution time
 
-By default `30` samples are taken, and `1` sample for the warmup phase. If you need to change number of measurement samples use `:times`:
+By default `1` measurement is taken, and `1` warmup cycle is run. If you need to change number of measurements taken use `:repeat`:
 
 ```ruby
-mean, std_dev = Benchmark::Perf::ExecutionTime.run(times: 10) { ... }
+mean, std_dev = Benchmark::Perf::ExecutionTime.run(repeat: 10) { ... }
 ```
 
 And to change number of warmup cycles use `:warmup` keyword like so:

data/lib/benchmark/perf/execution_time.rb

@@ -71,8 +71,8 @@ module Benchmark
 
       # Perform work x times
       #
-      # @param [Integer] times
-      #   how many times sample the code measuremenets
+      # @param [Integer] repeat
+      #   how many times to repeat the code measuremenets
       #
       # @example
       #   ExecutionTime.run(times: 10) { ... }
@@ -81,12 +81,12 @@ module Benchmark
       #   average and standard deviation
       #
       # @api public
-      def run(times: 30, io: nil, warmup: 1, &work)
-        range = linear_range(1, times - 1)
+      def run(repeat: 1, io: nil, warmup: 1, &work)
+        check_greater(repeat, 0)
         measurements = []
         run_warmup(warmup: warmup, &work)
 
-        range.each do
+        repeat.times do
           GC.start
           measurements << run_in_subprocess(io: io) do
             Perf.clock_time(&work)
@@ -97,6 +97,22 @@ module Benchmark
         [Perf.average(measurements), Perf.std_dev(measurements)]
       end
       module_function :run
+
+      # Check if expected value is greater than minimum
+      #
+      # @param [Numeric] expected
+      # @param [Numeric] min
+      #
+      # @raise [ArgumentError]
+      #
+      # @api private
+      def check_greater(expected, min)
+        unless expected > min
+          raise ArgumentError,
+                "Repeat value: #{expected} needs to be greater than #{min}"
+        end
+      end
+      module_function :check_greater
     end # ExecutionTime
   end # Perf
 end # Benchmark

data/lib/benchmark/perf/version.rb

@@ -2,6 +2,6 @@
 
 module Benchmark
   module Perf
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end # Perf
 end # Benchmark

data/spec/unit/assertions_spec.rb

@@ -3,7 +3,7 @@
 RSpec.describe Benchmark::Perf, 'assertions' do
   it "passes asertion by performing under threshold" do
     bench = Benchmark::Perf
-    assertion = bench.assert_perform_under(0.01, times: 2) { 'x' * 1_024 }
+    assertion = bench.assert_perform_under(0.01, repeat: 2) { 'x' * 1_024 }
     expect(assertion).to eq(true)
   end
 

data/spec/unit/execution_time_spec.rb

@@ -7,16 +7,29 @@ RSpec.describe Benchmark::Perf::ExecutionTime do
 
   it "provides default benchmark range" do
     allow(described_class).to receive(:run_in_subprocess).and_return(0.1)
-    described_class.run { 'x' * 1024 }
-    expect(described_class).to have_received(:run_in_subprocess).exactly(30).times
+    described_class.run(warmup: 0) { 'x' * 1024 }
+    expect(described_class).to have_received(:run_in_subprocess).once
   end
 
   it "accepts custom number of samples" do
     allow(described_class).to receive(:run_in_subprocess).and_return(0.1)
-    described_class.run(times: 12) { 'x' * 1024 }
+    described_class.run(repeat: 12, warmup: 0) { 'x' * 1024 }
     expect(described_class).to have_received(:run_in_subprocess).exactly(12).times
   end
 
+  it "doesn't accept range smaller than 1" do
+    allow(described_class).to receive(:run_in_subprocess).and_return(0.1)
+    described_class.run(repeat: 1, warmup: 1) { 'x' }
+    expect(described_class).to have_received(:run_in_subprocess).twice
+  end
+
+  it "doesn't accept range smaller than 1" do
+    expect {
+      described_class.run(repeat: 0) { 'x' }
+    }.to raise_error(ArgumentError,
+                    'Repeat value: 0 needs to be greater than 0')
+  end
+
   it "provides measurements for 30 samples by default" do
     sample = described_class.run { 'x' * 1024 }
     expect(sample).to all(be < 0.01)
@@ -39,7 +52,7 @@ RSpec.describe Benchmark::Perf::ExecutionTime do
   end
 
   it "measures work performance for 10 samples" do
-    sample = described_class.run(times: 10) { 'x' * 1_000_000 }
+    sample = described_class.run(repeat: 10) { 'x' * 1_000_000 }
     expect(sample.size).to eq(2)
     expect(sample).to all(be < 0.01)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-perf
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-16 00:00:00.000000000 Z
+date: 2018-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler