step-track 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2910a2b3884ec1d6c4dc68c915b635bebca88289
-  data.tar.gz: 6a69a58a9bd79328406355ba006a69f92b9e94f1
+  metadata.gz: 2fca015c0eda1a8f39a54e934b2c5240849b2bf4
+  data.tar.gz: 8a8bc2e016e62b963119984850982eb095ac9e9a
 SHA512:
-  metadata.gz: de480c9050dbf991ead7d0ffa53a300bb3a21a3278b6e3ed01e653b93137efc446cd24f4dac5e2cb7fa7bd9086e72e67c272c4e44e82acdd8333aba1d460c851
-  data.tar.gz: 1b99f2d02ae9c1bf0443baab7f99a1267e2126295ef27a7d43445a0b6ff2ea93b7ab3940101c3e37b2c423c9170f4948f56c8613d540a1dfaa32f6708ebcd1ef
+  metadata.gz: 2e47f3d294dc30f5e0bf67220ae39a44e4f70a7309abf511564e0ff29e7fe06b2e24d911792b32a7595875c38dc8075dd040833c8e979248dba615e4dc6c5f74
+  data.tar.gz: 1ebaa9ee674a619342c4ee674326776e17ef41f4aaaee6b30f2e5a77d6276195b95a76bfb8c7038a74e834bc96bfb4d2ce0ac32981643d75e14368919b1ceb1c

data/lib/step_track.rb

@@ -6,12 +6,22 @@ module StepTrack
   REF = "step_track/%{track}"
   DEFAULT_CONFIG = {merge_key: :merge, error_key: :error}.freeze
 
+  def get_caller
+    @caller ||= ->() { caller[1].sub(Dir.pwd + "/", "") }
+  end
+
+  def set_caller=(&blk)
+    @caller = blk
+  end
+
   def init(track, config={})
     raise ArgumentError, "callback block required" unless block_given?
     Thread.current[ref(track)] = {
+      track_id: config[:track_id] || Thread.current.object_id,
       steps: [],
       callback: Proc.new,
-      time: Time.now
+      time: Time.now,
+      caller: config&.[](:caller) || get_caller.()
     }.merge(DEFAULT_CONFIG).merge(config)
   end
 
@@ -24,7 +34,7 @@ module StepTrack
       split: Time.now.to_f - (last_step&.[](:time) || track_ref[:time]).to_f,
       duration: Time.now.to_f - track_ref[:time].to_f,
       time: Time.now,
-      caller: merge_step&.[](:caller) || caller[0].sub(Dir.pwd + "/", ""),
+      caller: merge_step&.[](:caller) || get_caller.(),
       step_name: merge_step&.[](:step_name) || name
     ).merge(payload)
   end
@@ -35,28 +45,27 @@ module StepTrack
     Thread.current[ref(track)] = nil
     steps = track_ref.delete(:steps)
     steps.each { |step| step.delete(:time) }
-    result = {step_count: steps.count}
+    result = {
+      step_count: steps.count,
+      caller: track_ref[:caller],
+      duration: Time.now.to_f - track_ref[:time].to_f,
+      track_id: track_ref[:track_id]
+    }
     if err = steps.detect { |s| s.key?(track_ref[:error_key]) }
       last_step = err.dup
     else
       last_step = steps.last&.dup || {}
     end
-    last_step[:final_step_name] = last_step.delete(:step_name)
-    result.merge!(last_step)
-    steps.each_with_index do |step, i|
-      name = name_dupe = step.delete(:step_name)
-      j = 0
-      while result.key?("step_#{name_dupe}_i".to_sym)
-        j += 1
-        name_dupe = "#{name}_#{j}"
-      end
-      name = name_dupe
-      result.merge!(step.merge(i: i + 1).
-        map { |k, v| ["step_#{name}_#{k}".to_sym, v] }.to_h)
-    end
+    result[:final_step_name] = last_step.delete(:step_name)
+    merge_down_steps!(result, steps)
     return track_ref[:callback].call(result)
   end
 
+  def track_id(track)
+    require_init!(track)
+    return Thread.current[ref(track)][:track_id]
+  end
+
   def partition_into(payload, name)
     payload, other = payload.partition do |k, _v|
       k.to_s !~ /^step_#{name}_/
@@ -89,4 +98,18 @@ module StepTrack
   def require_init!(track)
     raise ArgumentError, "track not initialized" unless initialized?(track)
   end
+
+  def merge_down_steps!(result, steps)
+    steps.each_with_index do |step, i|
+      name = name_dupe = step.delete(:step_name)
+      j = 0
+      while result.key?("step_#{name_dupe}_i".to_sym)
+        j += 1
+        name_dupe = "#{name}_#{j}"
+      end
+      name = name_dupe
+      result.merge!(step.merge(i: i + 1).
+        map { |k, v| ["step_#{name}_#{k}".to_sym, v] }.to_h)
+    end
+  end
 end

data/lib/step_track/version.rb

@@ -1,3 +1,3 @@
 module StepTrack
-  VERSION = "0.4.4"
+  VERSION = "0.5.0"
 end

data/test/step_track_test.rb

@@ -23,6 +23,15 @@ describe "StepTrack" do
         "callback is no proc #{data[:callback].inspect}"
       assert data[:time] <= Time.now,
         "time #{data[:time].inspect} > #{Time.now.inspect}"
+      assert_equal data[:track_id], Thread.current.object_id,
+        "track id is #{StepTrack.track_id("test")}"
+      refute_empty data[:caller], "caller is empty"
+    end
+
+    it "stores a track_id when given" do
+      StepTrack.init("test", track_id: "moobar") { }
+      assert_equal "moobar", StepTrack.track_id("test"),
+        "track id is #{StepTrack.track_id("test")}"
     end
   end
 
@@ -90,11 +99,26 @@ describe "StepTrack" do
       assert_equal 2, result[:step_count]
     end
 
-    it "merges the last step into result" do
+    it "sets the final step name" do
       result = StepTrack.done("test")
       assert_equal "last", result[:final_step_name]
-      expected_keys = [:split, :duration, :caller]
-      assert_equal expected_keys, expected_keys & result.keys
+    end
+
+    it "sets a duration" do
+      result = StepTrack.done("test")
+      assert result[:duration].is_a?(Float), "duration is no Float"
+      assert result[:duration] > 0.0, "duration is not positive"
+      assert result[:duration] < 1.0, "duration is too long"
+    end
+
+    it "sets a caller" do
+      result = StepTrack.done("test")
+      assert_match %r{#{Regexp.escape(__FILE__)}}, result[:caller]
+    end
+
+    it "does not merge final step into results" do
+      result = StepTrack.done("test")
+      assert !result.key?(:gnu), "merged gnu into result"
     end
 
     it "merges the error into result when available" do
@@ -106,7 +130,7 @@ describe "StepTrack" do
 
     it "enumerates every step into result" do
       result = StepTrack.done("test")
-      expected_key_parts = [:split, :duration, :caller]
+      expected_key_parts = [:i, :split, :duration, :caller]
 
       ["step", "last"].each_with_index do |n, i|
         expected_keys = expected_key_parts.map { |k| "step_#{n}_#{k}".to_sym }
@@ -117,7 +141,7 @@ describe "StepTrack" do
     it "enumerate duplicated step names with index in the result" do
       StepTrack.push("test", "last", gnu: "blu")
       result = StepTrack.done("test")
-      expected_key_parts = [:split, :duration, :caller]
+      expected_key_parts = [:i, :split, :duration, :caller]
 
       ["step", "last", "last_1"].each_with_index do |n, i|
         expected_keys = expected_key_parts.map { |k| "step_#{n}_#{k}".to_sym }
@@ -125,4 +149,22 @@ describe "StepTrack" do
       end
     end
   end
+
+  describe ".track_id" do
+    it "raises when not initialized" do
+      assert_raises ArgumentError do
+        StepTrack.track_id("test")
+      end
+    end
+
+    it "gives nil track_id when initialized without track_id" do
+      StepTrack.init("test") {  }
+      assert_equal Thread.current.object_id, StepTrack.track_id("test")
+    end
+
+    it "gives configured track_id when initialized with track_id" do
+      StepTrack.init("test", track_id: "1234") {  }
+      assert_equal "1234", StepTrack.track_id("test")
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: step-track
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Matthias Geier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-25 00:00:00.000000000 Z
+date: 2018-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest