benchmark-perf 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9e96517aac61f030785b74eebd97e06e49e74eda0bb7ce37854ed454817a5f9
-  data.tar.gz: 82a06c6df41203a33abbe439fe30fc0df64a2a22c26e5ef730fcb065733e0dbd
+  metadata.gz: 23be9b198b35a0cd2ba9fce98fe449cc11bf603d85361fd296fce4d25c4e6fcb
+  data.tar.gz: 4e88b12e133ad01323eca2dbae4aa1a36cfcc44390ef9883785fa9df14009618
 SHA512:
-  metadata.gz: b09c694ef8fe8d30f21407a0a16d3ce8a86ac139257a08876ad1cf2cce298d2dfccee5f2078e75ec2420985bcd8588383a442a9f1e1d85f52a17ea4889b50bb2
-  data.tar.gz: 4c4e308e46b4874bf656f15716500149a1d3daa869f330714c478bac1d50cb3b224cb6f2587a385d1adcc1545b45dd003020696a8468dec645d68e6531175c99
+  metadata.gz: 8cc2086bbfcedfa67021a9cd6fdc9ea0a6b04bbedf1457cd8a1921d28dde118a328b95568a0d361313ae0c4f16f18187fc023f76e6f82b185cb28355859d941b
+  data.tar.gz: '0962f8911d08ec0be76097fc7bb7a225031ed943214c6be85dfebd909e606168463061013bd22cfc2e18c782861f6e3b5f12c51f935eec300e5923b63a8e0016'

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change log
 
+## [v0.5.0] - 2019-04-21
+
+### Added
+* Add :subprocess option To ExecutionTime#run for toggling forking behaviour
+
+### Changed
+* Remove ExecutiomTime#linear_range
+* Change to relax development dependencies versions
+
 ## [v0.4.0] - 2018-09-30
 
 ### Changed

data/README.md

@@ -77,6 +77,14 @@ If you're interested in having debug output to see exact measurements for each i
 Benchmark::Perf::ExecutionTime.run(io: $stdout) { ... }
 ```
 
+By default all measurements are done in subprocess to isolate them from other process activities. This may have negative consequences, for example when your code uses database connections and transactions. To switch this behaviour off use `:subprocess` option.
+
+```ruby
+Benchmark::Perf::ExeuctionTime.run(subprocess: false) { ... }
+```
+
+Or use the environment variable `RUN_IN_SUBPROCESS` to toggle the behaviour.
+
 ### 2.2 Iterations
 
 In order to check how many iterations per second a given code takes do:
@@ -105,6 +113,10 @@ Benchmark::Perf::Iteration.run(time: 3.5) { ... } # 3.5 seconds
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+## Code of Conduct
+
+Everyone interacting in the Strings project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/benchmark-perf/blob/master/CODE_OF_CONDUCT.md).
+
 ## Copyright
 
-Copyright (c) 2016-2018 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2016 Piotr Murach. See LICENSE for further details.

data/Rakefile

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require "bundler/gem_tasks"
 
 FileList['tasks/**/*.rake'].each(&method(:import))
@@ -8,4 +6,3 @@ desc 'Run all specs'
 task ci: %w[ spec ]
 
 task default: :spec
-

data/benchmark-perf.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name          = "benchmark-perf"
   spec.version       = Benchmark::Perf::VERSION
   spec.authors       = ["Piotr Murach"]
-  spec.email         = [""]
+  spec.email         = ["me@piotrmurach.com"]
   spec.summary       = %q{Execution time and iteration performance benchmarking}
   spec.description   = %q{Execution time and iteration performance benchmarking}
   spec.homepage      = ""
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler', '>= 1.16'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake'
 end

data/lib/benchmark/perf.rb

@@ -18,6 +18,7 @@ module Benchmark
     # @api public
     def average(measurements)
       return 0 if measurements.empty?
+
       measurements.reduce(&:+).to_f / measurements.size
     end
     module_function :average
@@ -31,6 +32,7 @@ module Benchmark
     # @api public
     def variance(measurements)
       return 0 if measurements.empty?
+
       avg = average(measurements)
       total = measurements.reduce(0) do |sum, x|
         sum + (x - avg)**2
@@ -46,6 +48,7 @@ module Benchmark
     # @api public
     def std_dev(measurements)
       return 0 if measurements.empty?
+
       Math.sqrt(variance(measurements))
     end
     module_function :std_dev
@@ -81,14 +84,13 @@ module Benchmark
       def time_now
         Process.clock_gettime Process::CLOCK_MONOTONIC
       end
-      module_function :time_now
     else
       # Object represeting current time
       def time_now
         Time.now
       end
-      module_function :time_now
     end
+    module_function :time_now
 
     # Measure time elapsed with a monotonic clock
     #

data/lib/benchmark/perf/execution_time.rb

@@ -6,13 +6,13 @@ module Benchmark
     #
     # @api public
     module ExecutionTime
-      # Set of ranges in linear progression
+      # Check if measurements need to run in subprocess
       #
-      # @api public
-      def linear_range(min, max, step = 1)
-        (min..max).step(step).to_a
+      # @api private
+      def run_in_subprocess?
+        ENV["RUN_IN_SUBPROCESS"] != 'false' && Process.respond_to?(:fork)
       end
-      module_function :linear_range
+      module_function :run_in_subprocess?
 
       # Isolate run in subprocess
       #
@@ -23,10 +23,14 @@ module Benchmark
       #   the elapsed time of the measurement
       #
       # @api private
-      def run_in_subprocess(io: nil)
-        return yield unless Process.respond_to?(:fork)
+      def run_in_subprocess(subprocess: true, io: nil)
+        return yield unless subprocess && Process.respond_to?(:fork)
+        return yield unless run_in_subprocess?
 
         reader, writer = IO.pipe
+        reader.binmode
+        writer.binmode
+
         pid = Process.fork do
           GC.start
           GC.disable if ENV['BENCH_DISABLE_GC']
@@ -34,20 +38,21 @@ module Benchmark
           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
+            writer.close
+            exit # allow finalizers to run
           end
         end
 
         writer.close unless writer.closed?
         Process.waitpid(pid)
         data = Marshal.load(reader)
+        reader.close
         raise data if data.is_a?(Exception)
         data
       end
@@ -59,10 +64,11 @@ module Benchmark
       #   the warmup time
       #
       # @api private
-      def run_warmup(warmup: 1, &work)
+      def run_warmup(warmup: 1, io: nil, subprocess: true, &work)
         GC.start
+
         warmup.times do
-          run_in_subprocess do
+          run_in_subprocess(io: io, subprocess: subprocess) do
             Perf.clock_time(&work)
           end
         end
@@ -81,14 +87,15 @@ module Benchmark
       #   average and standard deviation
       #
       # @api public
-      def run(repeat: 1, io: nil, warmup: 1, &work)
+      def run(repeat: 1, io: nil, warmup: 1, subprocess: true, &work)
         check_greater(repeat, 0)
         measurements = []
-        run_warmup(warmup: warmup, &work)
+
+        run_warmup(warmup: warmup, io: io, subprocess: subprocess, &work)
 
         repeat.times do
           GC.start
-          measurements << run_in_subprocess(io: io) do
+          measurements << run_in_subprocess(io: io, subprocess: subprocess) do
             Perf.clock_time(&work)
           end
         end

data/lib/benchmark/perf/version.rb

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

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-if RUBY_VERSION > '1.9' and (ENV['COVERAGE'] || ENV['TRAVIS'])
+if ENV['COVERAGE'] || ENV['TRAVIS']
   require 'simplecov'
   require 'coveralls'
 
@@ -15,7 +15,7 @@ if RUBY_VERSION > '1.9' and (ENV['COVERAGE'] || ENV['TRAVIS'])
   end
 end
 
-require 'benchmark-perf'
+require "benchmark-perf"
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|

data/spec/unit/arithmetic_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 RSpec.describe Benchmark::Perf, 'arithmetic' do
   context '#average' do

data/spec/unit/assertions_spec.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal
+# frozen_string_literal: true
 
 RSpec.describe Benchmark::Perf, 'assertions' do
   it "passes asertion by performing under threshold" do

data/spec/unit/execution_time_spec.rb

@@ -1,37 +1,60 @@
 # frozen_string_literal: true
 
 RSpec.describe Benchmark::Perf::ExecutionTime do
-  it "provides linear range" do
-    expect(described_class.linear_range(0, 3)).to eq([0,1,2,3])
-  end
-
   it "provides default benchmark range" do
     allow(described_class).to receive(:run_in_subprocess).and_return(0.1)
+
     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(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
+  it "runs warmup cycles" 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 run in subproces when option :run_in_subprocess is set to false",
+    if: ::Process.respond_to?(:fork) do
+
+    allow(::Process).to receive(:fork)
+
+    described_class.run(subprocess: false) { 'x' * 1024 }
+
+    expect(::Process).to_not have_received(:fork)
+  end
+
+  it "doesn't run in subprocess when RUN_IN_SUBPROCESS env var is set to false",
+    if: ::Process.respond_to?(:fork) do
+
+    allow(::Process).to receive(:fork)
+    allow(ENV).to receive(:[]).with("RUN_IN_SUBPROCESS").and_return('false')
+
+    described_class.run { 'x' * 1024 }
+
+    expect(::Process).to_not have_received(:fork)
+  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')
+    }.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)
   end
 
@@ -43,16 +66,19 @@ RSpec.describe Benchmark::Perf::ExecutionTime do
 
   it "measures complex object" do
     sample = described_class.run { {foo: Object.new, bar: :piotr} }
+
     expect(sample).to all(be < 0.01)
   end
 
   it "executes code to warmup ruby vm" do
     sample = described_class.run_warmup { 'x' * 1_000_000 }
+
     expect(sample).to eq(1)
   end
 
   it "measures work performance for 10 samples" do
     sample = described_class.run(repeat: 10) { 'x' * 1_000_000 }
+
     expect(sample.size).to eq(2)
     expect(sample).to all(be < 0.01)
   end

data/tasks/console.rake

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 desc 'Load gem inside irb console'
 task :console do

data/tasks/coverage.rake

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 desc 'Measure code coverage'
 task :coverage do

data/tasks/spec.rake

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 begin
   require 'rspec/core/rake_task'

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-perf
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-30 00:00:00.000000000 Z
+date: 2019-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
@@ -42,19 +42,19 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 description: Execution time and iteration performance benchmarking
 email:
-- ''
+- me@piotrmurach.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -96,8 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Execution time and iteration performance benchmarking