traces 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cebb7ae2c860c548687f52033498988db4098d4fe4cba8a14c3fc72cfe957049
-  data.tar.gz: 5d13eb16c1d4506680b675568caa8e6f34751a2e1c6cd3abe8a1985c2e20933b
+  metadata.gz: '08840f587a19c2f5f8300c832a29409c5fa2e59c9607cc2c38586baa7db4b573'
+  data.tar.gz: 42c1503ae596a3d8bdc8ece4bd839c09cdfa638236e4c64b1d4c42fcfcbe503e
 SHA512:
-  metadata.gz: 31c2216adb04fdb0c0bb63efac6a1f3e542c9b631bba09f66661d0adc16f15cb68102f374b67c65215a945b3c3a3e9bb71d1bd4295749aed856e75bbe6c35942
-  data.tar.gz: fa7f67ae12ddd7c2bc71525e2b0390dc862689a87f6c92ffa10058ca7f788a7c0974891de94c003245531666a1335efa4ab10c4895f8c5b897ff9cd77e156e8c
+  metadata.gz: cf699c4c10ddca5ffc2a40b70498dee12df99cd801c5820a20eab9ef0aa1772871e09fb4d4019415b3be66f02396260613950c124229374401356bc9536e90a6
+  data.tar.gz: 192db05a4272dd9420aa3341928289da2afd31a0c0181ec621f6bce0ba87ede6ac6575d3c17c6f2513cae94ce48c9216c5da1ddfe45ea6fdaa5f5a067aca985d

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
@@ -46,49 +47,49 @@ module Traces
 						raise ArgumentError, "Invalid name!"
 					end
 					
-					unless String(Value)
+					unless String(value)
 						raise ArgumentError, "Invalid value!"
 					end
 				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/backend.rb

@@ -23,10 +23,6 @@
 module Traces
 	# Require a specific trace backend.
 	def self.require_backend(env = ENV)
-		if const_defined?(:Backend)
-			raise RuntimeError, "Backend already required!"
-		end
-		
 		if backend = env['TRACES_BACKEND']
 			require(backend)
 		end

data/lib/traces/context.rb

@@ -49,7 +49,7 @@ module Traces
 		# Create a local trace context which is likley to be globally unique.
 		# @parameter flags [Integer] Any trace context flags.
 		def self.local(flags = 0, **options)
-			self.new(SecureRandom.hex(16), SecureRandom.hex(8), flags, options)
+			self.new(SecureRandom.hex(16), SecureRandom.hex(8), flags, **options)
 		end
 		
 		# Nest a local trace context in an optional parent context.

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.0"
+	VERSION = "0.4.1"
 end

metadata

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