micro_bench 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b772118be3419e0878ddf0f0cec08a83c67eefb
+  data.tar.gz: 1e08246f863d68db6434eeeb60ffd6bd8e04bc61
+SHA512:
+  metadata.gz: cc8cc8b61b6324d3fbb5a0e6d430b1dfbe057f7e23d802b4bf1094cb74795e49cf59461a9ed9431c96a17001d22383b8789079e2238c687e46437058f0914615
+  data.tar.gz: 1f6c2876766fec38271ef0245a9e9af48ee5fe5585e73435b2259dd70a0a8b752dfe439e7b28fcc6d560326bbe9337281f57825b89b547288f85b07dd5a6f9ca

data/README.md

@@ -0,0 +1,102 @@
+
+# MicroBench
+
+[![Gem Version](https://badge.fury.io/rb/micro_bench.svg)](https://badge.fury.io/rb/micro_bench)
+
+Ruby `Benchmark` module is nice but it uses blocks. We see 2 problems to it :
+- if we want to instrument a snippet of code, it breaks git history,
+- variables are tied to the benchmark block, so we have to initialize them outside of the benchmark block to use them subsequently.
+
+Let's say you want to output the duration of `method_1` from :
+
+```ruby
+foo = method_1
+method_2(foo)
+```
+
+With `Benchmark`, we would write something like :
+```ruby
+foo = nil
+duration = Benchmark.realtime do
+  foo = method_1
+end
+puts "Method 1 duration : #{duration} seconds"
+method_2(foo)
+```
+
+With `MicroBench`, it will look like this :
+```ruby
+MicroBench.start
+foo = method_1
+puts "Method 1 duration : #{MicroBench.duration} seconds"
+method_2(foo)
+```
+
+## Install
+
+```
+gem install micro_bench
+```
+
+or in Bundler:
+```ruby
+gem "micro_bench"
+```
+
+## Usage
+
+### Basic usage
+
+```ruby
+require "micro_bench"
+
+MicroBench.start
+
+MicroBench.duration
+# 1.628093000501394
+
+MicroBench.duration
+# 2.999483000487089
+
+MicroBench.stop
+# true
+
+MicroBench.duration
+# 5.4341670004651
+
+MicroBench.duration
+# 5.4341670004651
+```
+
+### Named benchmarks
+
+```ruby
+require "micro_bench"
+
+MicroBench.start("timer1")
+
+MicroBench.stop("timer1")
+
+MicroBench.duration("timer1")
+# 1.628093000501394
+```
+
+### Thread safety
+
+A benchmark is tied to a thread, ensuring that `MicroBench` is thread-safe. At the same time, it doesn't allow to share a benchmark between multiple threads.
+
+### Multiple starts
+
+Calling `.start` multiple times with the same `bench_id` will cause a "restart" of the given benchmark.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/klaxit/micro_bench/tags).
+
+## Authors
+
+See the list of [contributors](https://github.com/klaxit/micro_bench/contributors) who participated in this project.
+
+## License
+
+Please see LICENSE

data/lib/micro_bench/benchmark.rb

@@ -0,0 +1,31 @@
+class MicroBench::Benchmark
+  def initialize
+    @start_time = monotonic_clock_time
+  end
+
+  def stop
+    return false unless running?
+
+    @duration = monotonic_clock_time - @start_time
+
+    return true
+  end
+
+  def duration
+    @duration || (monotonic_clock_time - @start_time)
+  end
+
+  def running?
+    @duration.nil?
+  end
+
+  def to_s
+    duration.to_s
+  end
+
+  private
+
+  def monotonic_clock_time
+    Process.clock_gettime(Process::CLOCK_MONOTONIC)
+  end
+end

data/lib/micro_bench/version.rb

@@ -0,0 +1,3 @@
+module MicroBench
+  VERSION = "0.1.1".freeze
+end

data/lib/micro_bench.rb

@@ -0,0 +1,70 @@
+module MicroBench
+  class << self
+    # Start a benchmark
+    #
+    # == Parameters:
+    # bench_id::
+    #   Identifier of the benchmark
+    #
+    # == Returns:
+    # A boolean representing success
+    #
+    # == Example usage:
+    #   MicroBench.start(:my_benchmark)
+    #
+    # Calling the method multiple times with the same bench_id will restart
+    # the benchmark for the given bench_id.
+    #
+    def start(bench_id = nil)
+      benchmarks[benchmark_key(bench_id)] = MicroBench::Benchmark.new
+      return true
+    end
+
+    # Stop a benchmark
+    #
+    # == Parameters:
+    # bench_id::
+    #   Identifier of the benchmark
+    #
+    # == Returns:
+    # A boolean representing success
+    #
+    # == Example usage:
+    #   MicroBench.stop(:my_benchmark)
+    #
+    def stop(bench_id = nil)
+      key = benchmark_key(bench_id)
+      return false unless benchmarks.key?(key)
+
+      benchmarks[key].stop
+    end
+
+    # Give duration of the benchmark
+    #
+    # == Parameters:
+    # bench_id::
+    #   Identifier of the benchmark
+    #
+    # == Returns:
+    # Duration of the given benchmark, or nil if benchmark is unknown
+    #
+    # == Example usage:
+    #   MicroBench.stop(:my_benchmark)
+    #
+    def duration(bench_id = nil)
+      benchmarks[benchmark_key(bench_id)]&.duration
+    end
+
+    private
+
+    def benchmarks
+      @benchmarks ||= {}
+    end
+
+    def benchmark_key(bench_id = nil)
+      "#{Thread.current.object_id}||#{bench_id}"
+    end
+  end
+end
+
+require "micro_bench/benchmark"

data/spec/micro_bench/micro_bench_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+describe MicroBench do
+  it "gives seconds duration doing something" do
+    described_class.start
+    sleep(0.01)
+    expect(
+      described_class.duration.round(2)
+    ).to eq(0.01)
+  end
+
+  it "allows to stop benchmark" do
+    described_class.start
+    sleep(0.01)
+    described_class.stop
+    sleep(0.02)
+    expect(
+      described_class.duration.round(2)
+    ).to eq(0.01)
+  end
+
+  it "restart each time 'start' is called" do
+    described_class.start
+    sleep(0.02)
+    described_class.start
+    sleep(0.01)
+    expect(
+      described_class.duration.round(2)
+    ).to eq(0.01)
+  end
+
+  it "allows multiple parallel named benchmarks" do
+    described_class.start(:bench1)
+    described_class.start(:bench2)
+    sleep(0.01)
+    described_class.stop(:bench1)
+    sleep(0.01)
+    described_class.stop(:bench2)
+    expect(
+      described_class.duration(:bench1).round(2)
+    ).to eq(0.01)
+    expect(
+      described_class.duration(:bench2).round(2)
+    ).to eq(0.01 * 2)
+  end
+
+  it "is thread safe" do
+    t1 = Thread.new do
+      described_class.start
+      sleep(0.01)
+      described_class.stop
+      Thread.current[:expected] = 0.01
+      Thread.current[:duration] = described_class.duration
+    end
+    t2 = Thread.new do
+      described_class.start
+      sleep(0.01 * 2)
+      described_class.stop
+      Thread.current[:expected] = 0.01 * 2
+      Thread.current[:duration] = described_class.duration
+    end
+    [t1, t2].each do |t|
+      t.join
+      expect(t[:duration].round(2)).to eq(t[:expected])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift File.join(__dir__, "..", "lib")
+
+require "bundler/setup"
+require "byebug"
+require "micro_bench"
+
+RSpec.configure do |config|
+  # Config goes here
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: micro_bench
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Cyrille Courtière
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: 
+email:
+- cyrille@klaxit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/micro_bench.rb
+- lib/micro_bench/benchmark.rb
+- lib/micro_bench/version.rb
+- spec/micro_bench/micro_bench_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/klaxit/micro_bench
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Dead simple benchmarks
+test_files:
+- spec/micro_bench/micro_bench_spec.rb
+- spec/spec_helper.rb