traces 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17d36e478e92a07d18262c627d9c2986004a2fe81985fd80721da6adf4d2c282
-  data.tar.gz: 44c0dd539bcda08a88d69478c56eeaa7eaa52f34b4bc2941510b7996d4b2bf28
+  metadata.gz: 389518e7025f63c5c99a5599000e12191ca8634b38f8d05ba727fe22b0fe3aa5
+  data.tar.gz: f8648d7990686c3abbd955f4b45869cf67c88e2b644da156e914bc2cac92087d
 SHA512:
-  metadata.gz: 5684c47004efb75753fed8f3c7d980cd72d6646c8eaa2eafc2fc001d25a96c80c7c3ad590d01fb7859544e8567c4318a29892cba70ec2fcaeefd81219ce6f34d
-  data.tar.gz: 8c8f7abd2de878319c61b8ffa491d8946f9fc8b782aad65911520948bc1efe4d545e10829fe0ee63b465443358ad858430429e485d3378238cd6e70e70464d06
+  metadata.gz: a3d9834ff556a722bb7a82dae4c824c94888af648a70954ab2a7c720e26e622ce826262838016169388734b8f9beaa6c2b74cd0a4ea9a669295fce70ae41c61c
+  data.tar.gz: 4fd9a0b83fb293e04fec5ff91431ee55ac2a6fcb86609288795d4d22486cf51fdcb16ec21610487b6e99d9b5662ab30d0999360ce5aaf430408b75a56ae077b8

data/lib/traces/backend/console.rb

@@ -31,6 +31,7 @@ end
 
 module Traces
 	module Backend
+		# A backend which logs all spans to the console logger output.
 		module Console
 			# A span which validates tag assignment.
 			class Span
@@ -50,41 +51,40 @@ module Traces
 				end
 			end
 			
-			private
-			
-			# Trace the given block of code and log the execution.
-			# @parameter name [String] A useful name/annotation for the recorded span.
-			# @parameter attributes [Hash] Metadata for the recorded span.
-			def trace(name, attributes: {}, &block)
-				context = Context.nested(Fiber.current.traces_backend_context)
-				Fiber.current.traces_backend_context = context
-				
-				::Console.logger.info(self, name, attributes)
+			module Interface
+				# Trace the given block of code and log the execution.
+				# @parameter name [String] A useful name/annotation for the recorded span.
+				# @parameter attributes [Hash] Metadata for the recorded span.
+				def trace(name, attributes: {}, &block)
+					context = Context.nested(Fiber.current.traces_backend_context)
+					Fiber.current.traces_backend_context = context
+					
+					::Console.logger.info(self, name, attributes)
+					
+					if block.arity.zero?
+						yield
+					else
+						yield Span.new(context, self, name)
+					end
+				end
 				
-				if block.arity.zero?
-					yield
-				else
-					yield Span.new(context, self, name)
+				# Assign a trace context to the current execution scope.
+				def trace_context= context
+					Fiber.current.traces_backend_context = context
 				end
-			end
-			
-			# Assign a trace context to the current execution scope.
-			def trace_context= context
-				Fiber.current.traces_backend_context = context
-			end
-			
-			# Get a trace context from the current execution scope.
-			# @parameter span [Span] An optional span from which to extract the context.
-			def trace_context(span = nil)
-				if span
-					span.context
-				else
-					Fiber.current.traces_backend_context
+				
+				# Get a trace context from the current execution scope.
+				# @parameter span [Span] An optional span from which to extract the context.
+				def trace_context(span = nil)
+					if span
+						span.context
+					else
+						Fiber.current.traces_backend_context
+					end
 				end
 			end
 		end
 		
-		# This is the default.
-		self.include(Console)
+		Interface = Console::Interface
 	end
 end

data/lib/traces/backend/test.rb

@@ -29,6 +29,7 @@ end
 
 module Traces
 	module Backend
+		# A backend which validates interface usage.
 		module Test
 			# A span which validates tag assignment.
 			class Span
@@ -52,43 +53,43 @@ module Traces
 				end
 			end
 			
-			private
-			
-			# Trace the given block of code and validate the interface usage.
-			# @parameter name [String] A useful name/annotation for the recorded span.
-			# @parameter attributes [Hash] Metadata for the recorded span.
-			def trace(name, attributes: nil, &block)
-				unless name.is_a?(String)
-					raise ArgumentError, "Invalid name!"
+			module Interface
+				# Trace the given block of code and validate the interface usage.
+				# @parameter name [String] A useful name/annotation for the recorded span.
+				# @parameter attributes [Hash] Metadata for the recorded span.
+				def trace(name, attributes: nil, &block)
+					unless name.is_a?(String)
+						raise ArgumentError, "Invalid name!"
+					end
+					
+					context = Context.nested(Fiber.current.traces_backend_context)
+					Fiber.current.traces_backend_context = context
+					
+					if block.arity.zero?
+						yield
+					else
+						span = Span.new(context)
+						yield span
+					end
 				end
 				
-				context = Context.nested(Fiber.current.traces_backend_context)
-				Fiber.current.traces_backend_context = context
-				
-				if block.arity.zero?
-					yield
-				else
-					span = Span.new(context)
-					yield span
+				# Assign a trace context to the current execution scope.
+				def trace_context= context
+					Fiber.current.traces_backend_context = context
 				end
-			end
-			
-			# Assign a trace context to the current execution scope.
-			def trace_context= context
-				Fiber.current.traces_backend_context = context
-			end
-			
-			# Get a trace context from the current execution scope.
-			# @parameter span [Span] An optional span from which to extract the context.
-			def trace_context(span = nil)
-				if span
-					span.context
-				else
-					Fiber.current.traces_backend_context
+				
+				# Get a trace context from the current execution scope.
+				# @parameter span [Span] An optional span from which to extract the context.
+				def trace_context(span = nil)
+					if span
+						span.context
+					else
+						Fiber.current.traces_backend_context
+					end
 				end
 			end
 		end
 		
-		self.include(Test)
+		Interface = Test::Interface
 	end
-end
+end

data/lib/traces/provider.rb

@@ -37,7 +37,7 @@ module Traces
 			klass.extend(Provider)
 			
 			provider = klass.traces_provider
-			provider.prepend(Backend)
+			provider.prepend(Backend::Interface)
 			
 			klass.prepend(provider)
 			

data/lib/traces/version.rb

@@ -21,5 +21,5 @@
 # THE SOFTWARE.
 
 module Traces
-	VERSION = "0.3.2"
+	VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: traces
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Williams