test-tracer 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c710e73d40fc548607c8c7bd3f64fca63c51d4bf
-  data.tar.gz: 73cefdc49a1b223ac4550eeb60cbaef22c1022d3
+  metadata.gz: 5aec92aa1df0c6211be3ea74a19b890a0d5eaa54
+  data.tar.gz: 0ca806b78e8a2dbb8212677855aabb5a3c44c7f8
 SHA512:
-  metadata.gz: 6fc2cace5ee65ab2e6d92705247ba4fc8e3a7be02729162a68b46a24a5841d615e4ce46b3a85a62b4a94d775c1d6059fe5a528eda82e245e2fcfb148e31fb03a
-  data.tar.gz: 589a369924d5c35a7180e41a07fc3c3dfbccc2016bb45cfb14ebe89bbfd84a687bc3d5eb4f518c8ec70295f80e8839c4c0ec58ec1ae5863bf08b4fae1d1bc6dd
+  metadata.gz: feb91c2c9de9ee123e6f93dde5b66bb2e7b7440c85a00433f5f21ccdd7c5de98ad9a71754c519c94b6ff4839ac96a4f6f2619f04393bcfc84c7453e4813dfb76
+  data.tar.gz: 7ddb95a3bf3870bb2700f37aeed719940c54456d24ff48511e0f574e0f907757b636d1b737be5c291f40f2677e3f0f3ede010ee7fedf9d9d3234bf90fda4a25f

data/README.md

@@ -28,6 +28,9 @@ In addition to OT compatible methods `Test::Tracer` provides the following metho
 1. `spans` returns all spans, including those in progress.
 2. `finished_spans` returns only finished spans.
 
+The tracer plays nicely with other wrapping tracers until your wrapped span, and span context implements `wrapped`
+method. The method must return the wrapped item. You can customize the behaviour by implementing `Test::Wrapped::Extractor` and setting `wrapped_span_extractor` and/or `wrapped_span_context_extractor`.
+
 ### Usage
 
 ```ruby

data/lib/test/tracer.rb

@@ -1,10 +1,11 @@
 require 'opentracing'
 
-require_relative 'type_check'
+require 'test/type_check'
 require 'test/id_provider'
 require 'test/span_context'
 require 'test/span'
 require 'test/propagation'
+require 'test/wrapped'
 
 module Test
   class Tracer < OpenTracing::Tracer
@@ -13,8 +14,12 @@ module Test
     attr_reader :spans, :finished_spans
     attr_reader :injectors, :extractors
 
+    attr_accessor :wrapped_span_extractor
+    attr_accessor :wrapped_span_context_extractor
+
     attr_accessor :logger
 
+
     def initialize(logger: nil)
       @logger = logger
 
@@ -26,6 +31,10 @@ module Test
 
       register_codec(OpenTracing::FORMAT_TEXT_MAP, Propagation::TextMapCodec.new)
       register_codec(OpenTracing::FORMAT_RACK, Propagation::RackCodec.new)
+
+      default_extractor = Wrapped::DefaultExtractor.new
+      @wrapped_span_extractor = default_extractor
+      @wrapped_span_context_extractor = default_extractor
     end
 
     def register_injector(format, injector)
@@ -52,7 +61,7 @@ module Test
 
     # OT complaiant
     def start_span(operation_name, child_of: nil, references: nil, start_time: Time.now, tags: nil)
-      Type! child_of, ::Test::Span, ::Test::SpanContext, NilClass
+      child_of = extract_span(child_of) || extract_span_context(child_of)
 
       parent_context = child_of && child_of.respond_to?(:context) ? child_of.context : child_of
       new_context = parent_context ? ::Test::SpanContext.child_of(parent_context) : ::Test::SpanContext.root
@@ -68,8 +77,8 @@ module Test
 
     # OT complaiant
     def inject(span_context, format, carrier)
-      Type! span_context, ::Test::SpanContext, NilClass
       NotNull! format
+      span_context = extract_span_context(span_context)
 
       return unless carrier
 
@@ -105,5 +114,21 @@ module Test
     def log(severity, message)
       logger.log(severity, message) if logger
     end
+
+    def extract_span(span)
+      if Type?(span, ::Test::Span, NilClass)
+        span
+      else
+        wrapped_span_extractor.extract(span) if wrapped_span_extractor
+      end
+    end
+
+    def extract_span_context(span_context)
+      if Type?(span_context, ::Test::SpanContext, NilClass)
+        span_context
+      else
+        wrapped_span_context_extractor.extract(span_context) if wrapped_span_context_extractor
+      end
+    end
   end
 end

data/lib/test/wrapped.rb

@@ -0,0 +1,2 @@
+require "test/wrapped/extractor"
+require "test/wrapped/default_extractor"

data/lib/test/wrapped/default_extractor.rb

@@ -0,0 +1,9 @@
+module Test
+  module Wrapped
+    class DefaultExtractor
+      def extract(wrapper)
+        wrapper.wrapped if wrapper.respond_to?(:wrapped)
+      end
+    end
+  end
+end

data/lib/test/wrapped/extractor.rb

@@ -0,0 +1,12 @@
+module Test
+  module Wrapped
+    module Extractor
+      # Extract a wrapped span or span context.
+      #
+      # @param wrapper
+      # @return [Span, SpanContext, nil] the extracted Span, SpanContext or nil if none could be found
+      def extract(wrapper)
+      end
+    end
+  end
+end

data/test-tracer.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "test-tracer"
-  spec.version       = "1.1.4"
+  spec.version       = "1.2.0"
   spec.authors       = ["iaintshine"]
   spec.email         = ["bodziomista@gmail.com"]
 
@@ -13,6 +13,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/iaintshine/ruby-test-tracer"
   spec.license       = "Apache-2.0"
 
+  spec.required_ruby_version = ">= 2.2.0"
+
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-tracer
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - iaintshine
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-31 00:00:00.000000000 Z
+date: 2017-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentracing
@@ -94,6 +94,9 @@ files:
 - lib/test/span_context.rb
 - lib/test/tracer.rb
 - lib/test/type_check.rb
+- lib/test/wrapped.rb
+- lib/test/wrapped/default_extractor.rb
+- lib/test/wrapped/extractor.rb
 - test-tracer.gemspec
 homepage: https://github.com/iaintshine/ruby-test-tracer
 licenses:
@@ -107,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="