step-track 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 223ca527f32902f873a8c4b34a8e083a6bb91ca4
+  data.tar.gz: 1f3c345c51bfe5aa3959795824561ce433609e7c
+SHA512:
+  metadata.gz: 45ad270d69c98b573eea8b6bb53e747083e8a8511284726bac97737ced664aa8891a2bbd1cd1a68c4a3a9be0cc1470238a42c733ecf0a218e2c2f0c6fa00ee3a
+  data.tar.gz: dafca62752e93766a0377533cd3e3fe6ed6a946b41fe473076452d95c124548fa5fbd6c3a56edeb062829c1fbd1cfa19230ae67f06cf07e45b261c112ec37062

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2017, Matthias Geier
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/step_track.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module StepTrack
+  extend self
+
+  REF = "step_track/%{track}"
+
+  def init(track)
+    raise ArgumentError, "callback block required" unless block_given?
+    Thread.current[ref(track)] = {
+      steps: [],
+      callback: Proc.new,
+      time: Time.now
+    }
+  end
+
+  def push(track, name, payload={})
+    require_init!(track)
+    track_ref = Thread.current[ref(track)]
+    last_step = track_ref[:steps].last
+    track_ref[:steps] << {
+      split: Time.now - (last_step&.[](:time) || track_ref[:time]),
+      duration: Time.now - track_ref[:time],
+      time: Time.now,
+      caller: caller[0],
+      name: name
+    }.merge(payload)
+  end
+
+  def done(track)
+    require_init!(track)
+    track_ref = Thread.current[ref(track)]
+    Thread.current[ref(track)] = nil
+    steps = track_ref.delete(:steps)
+    steps.each { |step| step.delete(:time) }
+    result = {step_count: steps.count}
+    result.merge!(steps.last || {})
+    steps.each_with_index do |step, i|
+      result.merge!(step.map { |k, v| ["step_#{i}_#{k}".to_sym, v] }.to_h)
+    end
+    return track_ref[:callback].call(result)
+  end
+
+  private
+
+  def ref(track)
+    (REF % {track: track}).to_sym
+  end
+
+  def initialized?(track)
+    !Thread.current[ref(track)].nil?
+  end
+
+  def require_init!(track)
+    raise ArgumentError, "track not initialized" unless initialized?(track)
+  end
+end

data/lib/step_track/version.rb

@@ -0,0 +1,3 @@
+module StepTrack
+  VERSION = "0.1.0"
+end

data/test/runner.rb

@@ -0,0 +1,5 @@
+require "step_track"
+require "minitest/spec"
+require "minitest/autorun"
+
+Dir["**/*_test.rb"].shuffle.each { |f| load f }

data/test/step_track_test.rb

@@ -0,0 +1,99 @@
+describe "StepTrack" do
+  after do
+    Thread.current[StepTrack.send(:ref, "test")] = nil
+  end
+
+  describe ".init" do
+    it "raises when no block is given" do
+      begin
+        rescued = false
+        StepTrack.init("test")
+      rescue ArgumentError
+        rescued = true
+      end
+      assert rescued
+    end
+
+    it "stores the initialized data into thread context" do
+      StepTrack.init("test") { }
+      data = Thread.current[StepTrack.send(:ref, "test")]
+      assert_equal [], data[:steps],
+        "steps is no empty array #{data[:steps].inspect}"
+      assert data[:callback].is_a?(Proc),
+        "callback is no proc #{data[:callback].inspect}"
+      assert data[:time] <= Time.now,
+        "time #{data[:time].inspect} > #{Time.now.inspect}"
+    end
+  end
+
+  describe ".push" do
+    before do
+      StepTrack.init("test") { }
+    end
+
+    it "requires initialization" do
+      begin
+        rescued = false
+        StepTrack.push("no_init", "step")
+      rescue ArgumentError
+        rescued = true
+      end
+      assert rescued
+    end
+
+    it "pushes a step including payload into data" do
+      StepTrack.push("test", "step", moo: "bar")
+      data = Thread.current[StepTrack.send(:ref, "test")]
+      step = data[:steps].first
+      assert_equal 1, data[:steps].size
+      assert_equal "step", step[:name]
+      assert_equal "bar", step[:moo]
+      expected_keys = [:name, :split, :duration, :time, :caller]
+      assert_equal expected_keys, expected_keys & step.keys
+    end
+  end
+
+  describe ".done" do
+    before do
+      StepTrack.init("test") { |result| result }
+      StepTrack.push("test", "step", moo: "bar")
+      StepTrack.push("test", "last", gnu: "blu")
+    end
+
+    it "requires initialization" do
+      begin
+        rescued = false
+        StepTrack.done("no_init")
+      rescue ArgumentError
+        rescued = true
+      end
+      assert rescued
+    end
+
+    it "returns the callback result" do
+      result = StepTrack.done("test")
+      assert result.is_a?(Hash), "result is no hash #{result.inspect}"
+    end
+
+    it "sets a step count" do
+      result = StepTrack.done("test")
+      assert_equal 2, result[:step_count]
+    end
+
+    it "merges the last step into result" do
+      result = StepTrack.done("test")
+      assert_equal "last", result[:name]
+      expected_keys = [:name, :split, :duration, :caller]
+      assert_equal expected_keys, expected_keys & result.keys
+    end
+
+    it "enumerates every step into result" do
+      result = StepTrack.done("test")
+      expected_key_parts = [:name, :split, :duration, :caller]
+      2.times do |i|
+        expected_keys = expected_key_parts.map { |k| "step_#{i}_#{k}".to_sym }
+        assert_equal expected_keys, expected_keys & result.keys
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: step-track
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthias Geier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+description: Stores data fragments as steps for an executing trail
+email: 'mayutamano@gmail.com '
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/step_track.rb
+- lib/step_track/version.rb
+- test/runner.rb
+- test/step_track_test.rb
+homepage: https://github.com/matthias-geier/track_step
+licenses:
+- BSD-2-Clause
+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.1
+signing_key: 
+specification_version: 4
+summary: Tracks data fragments across the application
+test_files:
+- test/step_track_test.rb
+- test/runner.rb