benchmark-perf 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 701d132071e0459dc7526e5bcb7f0fce1c505b70
-  data.tar.gz: f765203b7e2b4f132782c44c027a2853aa7c3162
+  metadata.gz: 0f7284dedb5487f685a88a4de95d40e9ee55dffa
+  data.tar.gz: 3d10614990b23154c9c9f010def6b0fd88ab4d50
 SHA512:
-  metadata.gz: 37a9d93cfad38d010814a44c77483bce25c7237c4dee9547d980dec8be0ded2ba5c180ddc22457edd9944e1d99e7472d3b669d217bd42c93efaf6c51f465d11e
-  data.tar.gz: b9554efaa85360ae97e4d9ab7f74bbb1950c869e712cfc5cfda3562f753e4c18a34d715a4aa9efb0a4a07efa9852b7e811d39c1ccf37930500c89271aec19a91
+  metadata.gz: 9b73856c9343f95e520e514aaa49bf706cfe83e674191eefb09c7b50fc264d4cadf340ae04ea9d9b38c990ed4b9bcf9030ea5856653efadca6a78ee60c07db99
+  data.tar.gz: 950f7c866e8696dbd79022da75252350e38693922387768221de0d35b23cfc6a221d0485b153973076de39d5cdee3616a1440e80d443471b24726faeb4539fe0

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change log
 
+## [v0.2.0] - 2016-11-01
+
+### Added
+* Add variance calculation
+
+### Changed
+* Change to propagate errors from child process when measuring execution time
+
+### Fixed
+* Fix std_dev calculation
+
 ## [v0.1.1] - 2016-10-29
 
 ### Fixed
@@ -9,5 +20,6 @@
 
 Initial release
 
+[v0.2.0]: https://github.com/peter-murach/benchmark-perf/compare/v0.1.1...v0.2.0
 [v0.1.1]: https://github.com/peter-murach/benchmark-perf/compare/v0.1.0...v0.1.1
 [v0.1.0]: https://github.com/peter-murach/benchmark-perf/compare/v0.1.0

data/lib/benchmark/perf.rb

@@ -16,24 +16,35 @@ module Benchmark
     #   the average of given measurements
     #
     # @api public
-    def average(measurements)
+    def self.average(measurements)
       return 0 if measurements.empty?
       measurements.reduce(&:+).to_f / measurements.size
     end
 
+    # Calculate variance of measurements
+    #
+    # @param [Array[Float]] measurements
+    #
+    # @return [Float]
+    #
+    # @api public
+    def self.variance(measurements)
+      return 0 if measurements.empty?
+      avg = average(measurements)
+      total = measurements.reduce(0) do |sum, x|
+        sum + (x - avg)**2
+      end
+      total.to_f / measurements.size
+    end
+
     # Calculate standard deviation
     #
     # @param [Array[Float]] measurements
     #
     # @api public
-    def std_dev(measurements)
+    def self.std_dev(measurements)
       return 0 if measurements.empty?
-      average = average(measurements)
-      Math.sqrt(
-        measurements.reduce(0) do |sum, x|
-          sum + (x - average)**2
-        end.to_f / (measurements.size - 1)
-      )
+      Math.sqrt(variance(measurements))
     end
 
     # Run given work and gather time statistics
@@ -43,7 +54,7 @@ module Benchmark
     # @return [Boolean]
     #
     # @api public
-    def assert_perform_under(threshold, options = {}, &work)
+    def self.assert_perform_under(threshold, options = {}, &work)
       bench = ExecutionTime.new(options)
       actual, _ = bench.run(&work)
       actual <= threshold
@@ -56,12 +67,10 @@ module Benchmark
     # @return [Boolean]
     #
     # @api public
-    def assert_perform_ips(iterations, options = {}, &work)
+    def self.assert_perform_ips(iterations, options = {}, &work)
       bench = Iteration.new(options)
       mean, stddev, _ = bench.run(&work)
       iterations <= (mean + 3 * stddev)
     end
-
-    extend Benchmark::Perf
   end # Perf
 end # Benchmark

data/lib/benchmark/perf/execution_time.rb

@@ -52,22 +52,28 @@ module Benchmark
           GC.start
           GC.disable if ENV['BENCH_DISABLE_GC']
 
-          reader.close
-          time = yield
-
-          io.print "%9.6f" % time if io
-          Marshal.dump(time, writer)
-
-          GC.enable if ENV['BENCH_DISABLE_GC']
-          exit!(0) # run without hooks
+          begin
+            reader.close
+            time = yield
+
+            io.print "%9.6f" % data if io
+            Marshal.dump(time, writer)
+          rescue => error
+            Marshal.dump(error, writer)
+          ensure
+            GC.enable if ENV['BENCH_DISABLE_GC']
+            exit!(0) # run without hooks
+          end
         end
 
         writer.close unless writer.closed?
         Process.waitpid(pid)
         begin
-          Marshal.load(reader)
-        rescue => e
-          raise MarshalError, "#{e.class}: #{e.message}"
+          data = Marshal.load(reader)
+          raise data if data.is_a?(Exception)
+          data
+        rescue => error
+          raise MarshalError, "#{error.class}: #{error.message}"
         end
       end
 
@@ -77,7 +83,9 @@ module Benchmark
       def run_warmup(&work)
         GC.start
         @warmup.times do
-          run_in_subprocess { ::Benchmark.realtime(&work) }
+          run_in_subprocess do
+            ::Benchmark.realtime(&work)
+          end
         end
       end
 
@@ -101,7 +109,6 @@ module Benchmark
 
         range.each do
           GC.start
-
           measurements << run_in_subprocess do
             ::Benchmark.realtime(&work)
           end

data/lib/benchmark/perf/version.rb

@@ -2,6 +2,6 @@
 
 module Benchmark
   module Perf
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end # Perf
 end # Benchmark

data/spec/unit/arithmetic_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+RSpec.describe Benchmark::Perf, 'arithmetic' do
+  context '#average' do
+    it "calculates average without measurements" do
+      expect(Benchmark::Perf.average([])).to eq(0)
+    end
+
+    it "calculates average with measurements" do
+      expect(Benchmark::Perf.average([1,2,3])).to eq(2.0)
+    end
+  end
+
+  context '#variance' do
+    it "calculates variance of no measurements" do
+      expect(Benchmark::Perf.variance([])).to eq(0)
+    end
+
+    it "calculates variance of measurements" do
+      expect(Benchmark::Perf.variance([1,2,3])).to eq(2.to_f/3)
+    end
+  end
+
+  context '#std_dev' do
+    it "calculates standard deviation of no measurements" do
+      expect(Benchmark::Perf.std_dev([])).to eq(0)
+    end
+
+    it "calculates standard deviation of measurements" do
+      expect(Benchmark::Perf.std_dev([1,2,3])).to eq(Math.sqrt(2.to_f/3))
+    end
+  end
+end

data/spec/unit/assertions_spec.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-RSpec.describe Benchmark::Perf, '#assert_perform' do
+RSpec.describe Benchmark::Perf, 'assertions' do
   it "passes asertion by performing under threshold" do
     bench = Benchmark::Perf
     assertion = bench.assert_perform_under(0.01, samples: 2) { 'x' * 1_024 }

data/spec/unit/execution_time_spec.rb

@@ -17,6 +17,21 @@ RSpec.describe Benchmark::Perf::ExecutionTime do
     expect(sample).to all(be < 0.01)
   end
 
+  it "doesn't benchmark raised exception" do
+    bench = described_class.new
+    expect {
+      bench.run { raise 'boo' }
+    }.to raise_error(StandardError)
+  end
+
+  it "fails to load marshalled data" do
+    bench = described_class.new
+    allow(Marshal).to receive(:load).and_raise('boo')
+    expect {
+      bench.run { 'x' * 1024 }
+    }.to raise_error(Benchmark::Perf::MarshalError)
+  end
+
   it "measures complex object" do
     bench = described_class.new
     sample = bench.run { {foo: Object.new, bar: :piotr} }

data/spec/unit/iteration_spec.rb

@@ -15,4 +15,11 @@ RSpec.describe Benchmark::Perf::Iteration do
     expect(sample[1]).to be > 5
     expect(sample[2]).to be > 250
   end
+
+  it "does't measure broken code" do
+    bench = described_class.new
+    expect {
+      bench.run { raise 'boo' }
+    }.to raise_error(StandardError, /boo/)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-perf
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-29 00:00:00.000000000 Z
+date: 2016-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,8 +66,8 @@ files:
 - lib/benchmark/perf/iteration.rb
 - lib/benchmark/perf/version.rb
 - spec/spec_helper.rb
+- spec/unit/arithmetic_spec.rb
 - spec/unit/assertions_spec.rb
-- spec/unit/average_spec.rb
 - spec/unit/execution_time_spec.rb
 - spec/unit/iteration_spec.rb
 - tasks/coverage.rake
@@ -98,8 +98,8 @@ specification_version: 4
 summary: Execution time and iteration performance benchmarking
 test_files:
 - spec/spec_helper.rb
+- spec/unit/arithmetic_spec.rb
 - spec/unit/assertions_spec.rb
-- spec/unit/average_spec.rb
 - spec/unit/execution_time_spec.rb
 - spec/unit/iteration_spec.rb
 has_rdoc: 

data/spec/unit/average_spec.rb

@@ -1,11 +0,0 @@
-# encoding: utf-8
-
-RSpec.describe Benchmark::Perf do
-  it "calculates average without measurements" do
-    expect(Benchmark::Perf.average([])).to eq(0)
-  end
-
-  it "calculates average with measurements" do
-    expect(described_class.average([1,2,3])).to eq(2.0)
-  end
-end