micro_bench 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b772118be3419e0878ddf0f0cec08a83c67eefb
-  data.tar.gz: 1e08246f863d68db6434eeeb60ffd6bd8e04bc61
+  metadata.gz: a8c91db76af4392989e7cef3b27ab9bd4b421c77
+  data.tar.gz: 609656197b6121fab78832159497579b63c0b877
 SHA512:
-  metadata.gz: cc8cc8b61b6324d3fbb5a0e6d430b1dfbe057f7e23d802b4bf1094cb74795e49cf59461a9ed9431c96a17001d22383b8789079e2238c687e46437058f0914615
-  data.tar.gz: 1f6c2876766fec38271ef0245a9e9af48ee5fe5585e73435b2259dd70a0a8b752dfe439e7b28fcc6d560326bbe9337281f57825b89b547288f85b07dd5a6f9ca
+  metadata.gz: 295ec1527e81d7c5954dd949cb084b65c3c634bccacaed32a2ca16b8e86e5d4d1bb1ec6f759a523b201a4023d0b0e1d54d69e09c44f9a999240fece436b90306
+  data.tar.gz: d7d06b06eb69cc307900a9a3e6833815d61d7fa694b7830456d9d079560b3f13ec8395c30e0f041debfebd939417aad28adbbf330504e462f333dfd13ac4c570

data/README.md

@@ -81,13 +81,36 @@ MicroBench.duration("timer1")
 # 1.628093000501394
 ```
 
+### Multiple starts
+
+Calling `.start` multiple times with the same `bench_id` (or none) will cause a "restart" of the given benchmark.
+
 ### 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
+### Methods isolation
+
+A benchmark is tied to its calling method so the following code will output 2 separated durations for `method_1` and `method_2`. This prevent collisions when using `MicroBench` in a large codebase.
 
-Calling `.start` multiple times with the same `bench_id` will cause a "restart" of the given benchmark.
+```ruby
+def method_1
+  MicroBench.start
+  method_2
+  # Do something
+  MicroBench.stop
+  puts "method_1 duration : #{MicroBench.duration}"
+end
+
+def method_2
+  MicroBench.start
+  # Do something
+  MicroBench.stop
+  puts "method_2 duration : #{MicroBench.duration}"
+end
+
+method_1
+```
 
 ## Versioning
 

data/lib/micro_bench/version.rb

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

data/lib/micro_bench.rb

@@ -62,7 +62,18 @@ module MicroBench
     end
 
     def benchmark_key(bench_id = nil)
-      "#{Thread.current.object_id}||#{bench_id}"
+      "#{thread_key}||#{caller_key}||#{bench_id}"
+    end
+
+    def thread_key
+      Thread.current.object_id
+    end
+
+    def caller_key
+      caller_location = caller_locations(2..4).detect do |loc|
+        !loc.absolute_path.include?(__FILE__)
+      end
+      "#{caller_location.absolute_path}:#{caller_location.label}"
     end
   end
 end

data/spec/micro_bench/micro_bench_spec.rb

@@ -59,9 +59,35 @@ describe MicroBench do
       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
+
+  it "prevents cross-method collisions" do
+    test_klass = Class.new do
+      attr_accessor :method_1_duration
+      attr_accessor :method_2_duration
+      def method_1
+        MicroBench.start
+        method_2
+        sleep(0.01)
+        MicroBench.stop
+        @method_1_duration = MicroBench.duration
+      end
+      def method_2
+        MicroBench.start
+        sleep(0.01)
+        MicroBench.stop
+        @method_2_duration = MicroBench.duration
+      end
+    end
+
+    subject = test_klass.new
+    subject.method_1
+    expect(subject.method_1_duration).to_not eq(subject.method_2_duration)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: micro_bench
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Cyrille Courtière
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-29 00:00:00.000000000 Z
+date: 2018-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug