opentracing 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b098877231da8a45c53d373b62f2c9fde240fbea9c036206f85e206dce9cca4b
-  data.tar.gz: 76ceff6bdc3b43ee8aeff06804f149bab3b9d50a3a13166c84c42e1b13b09ed2
+  metadata.gz: a1afd30cdd521cbc991fb90ac3249941cffb92ce520971e9e30def058518f810
+  data.tar.gz: 57d94238f74b7e2e1e24dd6d902848263b1fa043a94eced9df5c176f2a906b2c
 SHA512:
-  metadata.gz: 354d5fbea56a5e6281145cbfc1dc586368c82673fa20d71539a51e5a45b580b49474b791bfe5b42403593a6a1e46864c16f6ccb3d41d6ce6682d1ce25de0cb30
-  data.tar.gz: 0657b98ddee67240e2078703c3fd1dd6d61da567399368980909ad02ab02d7bd74e6f8fd0037d4763aec7e72d178b0cd58f888a30fcbb031c326372472250bb2
+  metadata.gz: cb204bb822af323dc789bddf74d8acaa182621068358c0b681eaf8210e83e8ed654c53e311a5d867a908bd4c962a591d473be54dd5c5bd983987d1ee498f2018
+  data.tar.gz: d11c2bd895bbf11eda1f85bc01d0b4b90afa25bbdb11a3c99d99971e3ac140786fb8dc2680d2c9da52962cc3c0b959a66c30231107ad083f3e904006fef6c62e

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.5.0
+
+* Tracer#start_span now accepts an optional block. When passed a block, it returns the block's return value, otherwise it returns the newly-created span ([#45](https://github.com/opentracing/opentracing-ruby/pull/45)). See [Issue #13](https://github.com/opentracing/opentracing-ruby/issues/13).
+
+* When passed an optional block, Tracer#start_active_span returns the block's return value, otherwise it returns the newly-created scope. This is a change in behavior as it previously returned a scope in both cases([#45](https://github.com/opentracing/opentracing-ruby/pull/45)). See [Issue #41](https://github.com/opentracing/opentracing-ruby/issues/41).
+
+* Improved documentation for `log` and `log_kv` methods ([#44](https://github.com/opentracing/opentracing-ruby/pull/44))
+
 ## 0.4.3
 
 * Specify versions for development dependencies ([#40](https://github.com/opentracing/opentracing-ruby/pull/40))

data/lib/opentracing/span.rb

@@ -46,7 +46,7 @@ module OpenTracing
     # Add a log entry to this span
     # @param event [String] event name for the log
     # @param timestamp [Time] time of the log
-    # @param fields [Hash] Additional information to log
+    # @param fields [Hash{Symbol=>Object}] Additional information to log
     def log(event: nil, timestamp: Time.now, **fields)
       warn 'Span#log is deprecated.  Please use Span#log_kv instead.'
       nil
@@ -54,7 +54,7 @@ module OpenTracing
 
     # Add a log entry to this span
     # @param timestamp [Time] time of the log
-    # @param fields [Hash] Additional information to log
+    # @param fields [Hash{Symbol=>Object}] Additional information to log
     def log_kv(timestamp: Time.now, **fields)
       nil
     end

data/lib/opentracing/tracer.rb

@@ -42,10 +42,12 @@ module OpenTracing
     #   References#CHILD_OF reference to the ScopeManager#active.
     # @param finish_on_close [Boolean] whether span should automatically be
     #   finished when Scope#close is called
-    # @yield [Scope] If an optional block is passed to start_active it will
+    # @yield [Scope] If an optional block is passed to start_active_span it will
     #   yield the newly-started Scope. If `finish_on_close` is true then the
     #   Span will be finished automatically after the block is executed.
-    # @return [Scope] The newly-started and activated Scope
+    # @return [Scope, Object] If passed an optional block, start_active_span
+    #   returns the block's return value, otherwise it returns the newly-started
+    #   and activated Scope
     def start_active_span(operation_name,
                           child_of: nil,
                           references: nil,
@@ -54,7 +56,7 @@ module OpenTracing
                           ignore_active_scope: false,
                           finish_on_close: true)
       Scope::NOOP_INSTANCE.tap do |scope|
-        yield scope if block_given?
+        return yield scope if block_given?
       end
     end
 
@@ -74,15 +76,22 @@ module OpenTracing
     # @param tags [Hash] Tags to assign to the Span at start time
     # @param ignore_active_scope [Boolean] whether to create an implicit
     #   References#CHILD_OF reference to the ScopeManager#active.
-    # @return [Span] the newly-started Span instance, which has not been
-    #   automatically registered via the ScopeManager
+    # @yield [Span] If passed an optional block, start_span will yield the
+    #   newly-created span to the block. The span will be finished automatically
+    #   after the block is executed.
+    # @return [Span, Object] If passed an optional block, start_span will return
+    #  the block's return value, otherwise it returns the newly-started Span
+    #  instance, which has not been automatically registered via the
+    #  ScopeManager
     def start_span(operation_name,
                    child_of: nil,
                    references: nil,
                    start_time: Time.now,
                    tags: nil,
                    ignore_active_scope: false)
-      Span::NOOP_INSTANCE
+      Span::NOOP_INSTANCE.tap do |span|
+        return yield span if block_given?
+      end
     end
 
     # Inject a SpanContext into the given carrier

data/lib/opentracing/version.rb

@@ -1,3 +1,3 @@
 module OpenTracing
-  VERSION = '0.4.3'.freeze
+  VERSION = '0.5.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentracing
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - ngauthier
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-24 00:00:00.000000000 Z
+date: 2019-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest