Add bin and edit workflow

bin/gems/traces-0.15.2/lib/traces/backend/capture.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require_relative '../context'
+
+require 'fiber'
+
+Fiber.attr_accessor :traces_backend_context
+
+module Traces
+	module Backend
+		# A backend which logs all spans to the Capture logger output.
+		module Capture
+			# A span which validates tag assignment.
+			class Span
+				# Initialize a new span.
+				# @parameter context [Context] The context in which the span is recorded.
+				# @parameter name [String] A useful name/annotation for the recorded span.
+				# @parameter resource [String] The "resource" that the span is associated with.
+				# @parameter attributes [Hash] Metadata for the recorded span.
+				def initialize(context, name, resource, attributes)
+					@context = context
+					@name = name
+					@resource = resource
+					@attributes = attributes
+				end
+				
+				attr :context
+				attr :name
+				attr :resource
+				attr :attributes
+				
+				# Assign some metadata to the span.
+				# @parameter key [String] The metadata key.
+				# @parameter value [Object] The metadata value. Should be coercable to a string.
+				def []= key, value
+					@attributes[key] = value
+				end
+				
+				# Convert the span to a JSON representation.
+				def as_json
+					{
+						name: @name,
+						resource: @resource,
+						attributes: @attributes,
+						context: @context.as_json
+					}
+				end
+				
+				# Convert the span to a JSON string.
+				def to_json(...)
+					as_json.to_json(...)
+				end
+			end
+			
+			# All captured spans.
+			def self.spans
+				@spans ||= []
+			end
+			
+			# The capture backend interface.
+			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, resource: nil, attributes: {}, &block)
+					context = Context.nested(Fiber.current.traces_backend_context)
+					Fiber.current.traces_backend_context = context
+					
+					span = Span.new(context, name, resource, attributes)
+					Capture.spans << span
+					
+					yield span
+				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.
+				def trace_context
+					Fiber.current.traces_backend_context
+				end
+				
+				# @returns [Boolean] Whether there is an active trace.
+				def active?
+					!!Fiber.current.traces_backend_context
+				end
+			end
+		end
+		
+		Interface = Capture::Interface
+	end
+end

bin/gems/traces-0.15.2/lib/traces/backend/console.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2023, by Samuel Williams.
+
+require_relative '../context'
+
+require 'console'
+require 'fiber'
+
+Fiber.attr_accessor :traces_backend_context
+
+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
+				# Initialize a new span.
+				# @parameter context [Context] The context in which the span is recorded.
+				# @parameter name [String] A useful name/annotation for the recorded span.
+				def initialize(context, name)
+					@context = context
+					@name = name
+				end
+				
+				# @attribute [Context] The context in which the span is recorded.
+				attr :context
+				
+				# Assign some metadata to the span.
+				# @parameter key [String] The metadata key.
+				# @parameter value [Object] The metadata value. Should be coercable to a string.
+				def []= key, value
+					::Console.logger.info(@context, @name, "#{key} = #{value}")
+				end
+			end
+			
+			# The console backend interface.
+			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, resource: nil, attributes: {}, &block)
+					context = Context.nested(Fiber.current.traces_backend_context)
+					Fiber.current.traces_backend_context = context
+					
+					::Console.logger.info(resource || self, name, attributes)
+					
+					if block.arity.zero?
+						yield
+					else
+						yield Span.new(context, name)
+					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.
+				def trace_context
+					Fiber.current.traces_backend_context
+				end
+				
+				# @returns [Boolean] Whether there is an active trace.
+				def active?
+					!!Fiber.current.traces_backend_context
+				end
+			end
+		end
+		
+		Interface = Console::Interface
+	end
+end

bin/gems/traces-0.15.2/lib/traces/backend/test.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2023, by Samuel Williams.
+
+require_relative '../context'
+
+require 'fiber'
+
+Fiber.attr_accessor :traces_backend_context
+
+module Traces
+	module Backend
+		# A backend which validates interface usage.
+		module Test
+			# A span which validates tag assignment.
+			class Span
+				# Initialize a new span.
+				# @parameter context [Context] The context in which the span is recorded.
+				def initialize(context)
+					@context = context
+				end
+				
+				# @attribute [Context] The context in which the span is recorded.
+				attr :context
+				
+				# Assign some metadata to the span.
+				# @parameter key [String] The metadata key.
+				# @parameter value [Object] The metadata value. Should be coercable to a string.
+				def []= key, value
+					unless key.is_a?(String) || key.is_a?(Symbol)
+						raise ArgumentError, "Invalid attribute key (must be String or Symbol): #{key.inspect}!"
+					end
+					
+					begin
+						String(value)
+					rescue
+						raise ArgumentError, "Invalid attribute value (must be convertible to String): #{value.inspect}!"
+					end
+				end
+			end
+			
+			# The test backend interface.
+			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 resource [String] The context in which the trace operation is occuring.
+				# @parameter attributes [Hash] Metadata for the recorded span.
+				def trace(name, resource: nil, attributes: nil, &block)
+					unless block_given?
+						raise ArgumentError, "No block given!"
+					end
+					
+					unless name.is_a?(String)
+						raise ArgumentError, "Invalid name (must be String): #{name.inspect}!"
+					end
+					
+					# It should be convertable:
+					resource &&= resource.to_s
+					
+					context = Context.nested(Fiber.current.traces_backend_context)
+					
+					span = Span.new(context)
+					
+					# Ensure the attributes are valid and follow the requirements:
+					attributes&.each do |key, value|
+						span[key] = value
+					end
+					
+					Fiber.current.traces_backend_context = context
+					
+					if block.arity.zero?
+						yield
+					else
+						yield span
+					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.
+				def trace_context
+					Fiber.current.traces_backend_context
+				end
+				
+				# @returns [Boolean] Whether there is an active trace.
+				def active?
+					# For the sake of testing, we always enable tracing.
+					true
+				end
+			end
+		end
+		
+		Interface = Test::Interface
+	end
+end