trace_viz 0.0.1 → 0.0.2

data/lib/trace_viz/exporters/text_exporter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "base_exporter"
+
+module TraceViz
+  module Exporters
+    class TextExporter < BaseExporter
+      private
+
+      def content
+        data.join("\n")
+      end
+    end
+  end
+end

data/lib/trace_viz/exporters/transformers/base_transformer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module TraceViz
+  module Exporters
+    module Transformers
+      class BaseTransformer
+        def initialize(collector)
+          @collector = collector
+        end
+
+        def transform
+          raise NotImplementedError
+        end
+
+        private
+
+        attr_reader :collector
+
+        def collection
+          collector.collection
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/exporters/transformers/text_transformer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "base_transformer"
+require "trace_viz/exporters/formatters/method_call_formatter"
+require "trace_viz/exporters/formatters/method_return_formatter"
+
+module TraceViz
+  module Exporters
+    module Transformers
+      class TextTransformer < BaseTransformer
+        def transform
+          collection.map do |trace_data|
+            format_item(trace_data)
+          end
+        end
+
+        def format_item(trace_data)
+          case trace_data.event
+          when :call
+            Formatters::MethodCallFormatter.new(trace_data).format
+          when :return
+            Formatters::MethodReturnFormatter.new(trace_data).format
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/formatters/base_formatter.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "helpers/indent_helper"
+require_relative "helpers/depth_helper"
+require_relative "helpers/time_helper"
+require_relative "helpers/params_helper"
+require_relative "helpers/source_helper"
+require_relative "helpers/result_helper"
+require_relative "helpers/method_details_helper"
+
+module TraceViz
+  module Formatters
+    class BaseFormatter
+      #
+      # General formatting methods for TraceData::Base
+      # These methods are used to format the output of the trace data
+      # based on the configuration settings.
+      #
+
+      include Helpers::IndentHelper
+      include Helpers::DepthHelper
+      include Helpers::TimeHelper
+      include Helpers::ParamsHelper
+      include Helpers::SourceHelper
+      include Helpers::ResultHelper
+      include Helpers::MethodDetailsHelper
+
+      def initialize(trace_data)
+        @trace_data = trace_data
+        @config = @trace_data.config
+      end
+
+      def format
+        raise NotImplementedError
+      end
+
+      private
+
+      attr_reader :trace_data, :config
+    end
+  end
+end

data/lib/trace_viz/formatters/helpers/depth_helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module TraceViz
+  module Formatters
+    module Helpers
+      module DepthHelper
+        def depth_representation
+          return unless config.general[:show_depth]
+
+          if trace_data.depth.zero?
+            "depth[0]"
+          elsif trace_data.event == :call
+            "depth[#{trace_data.depth}]"
+          elsif trace_data.event == :return
+            "depth[#{trace_data.depth}]"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/formatters/helpers/indent_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module TraceViz
+  module Formatters
+    module Helpers
+      module IndentHelper
+        def indent_representation
+          return unless config.general[:show_indent] && config.general[:show_depth]
+
+          " " * (config.general[:tab_size] * trace_data.depth)
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/formatters/helpers/method_details_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module TraceViz
+  module Formatters
+    module Helpers
+      module MethodDetailsHelper
+        def method_name_representation
+          return unless config.general[:show_method_name]
+
+          "#{trace_data.klass}##{trace_data.action}"
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/formatters/helpers/params_helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "trace_viz/utils/format_utils"
+
+module TraceViz
+  module Formatters
+    module Helpers
+      module ParamsHelper
+        def params_representation
+          return unless config.params[:show]
+
+          truncated_params = trace_data.params.transform_values do |value|
+            Utils::FormatUtils.truncate_value(value, config.params[:truncate_values])
+          end
+
+          formatted_values = Utils::FormatUtils.format_key_value_pairs(
+            truncated_params,
+            config.params[:mode],
+          )
+
+          "(#{formatted_values})"
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/formatters/helpers/result_helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "trace_viz/utils/format_utils"
+
+module TraceViz
+  module Formatters
+    module Helpers
+      module ResultHelper
+        def result_representation
+          return unless config.result[:show]
+
+          truncated_result = Utils::FormatUtils.truncate_value(
+            trace_data.result.inspect,
+            config.result[:truncate_length],
+          )
+          "#=> #{truncated_result}"
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/formatters/helpers/source_helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "trace_viz/utils/format_utils"
+
+module TraceViz
+  module Formatters
+    module Helpers
+      module SourceHelper
+        def source_location_representation
+          return unless config.source_location[:show]
+
+          truncated_path = Utils::FormatUtils.truncate_value(
+            trace_data.path,
+            config.source_location[:truncate_length],
+          )
+          "at #{truncated_path}:#{trace_data.line_number}"
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/formatters/helpers/time_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module TraceViz
+  module Formatters
+    module Helpers
+      module TimeHelper
+        def execution_time_representation
+          return unless config.execution[:show_time] && trace_data.duration
+
+          "in #{trace_data.duration}ms"
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/logger.rb

@@ -2,72 +2,62 @@
 
 module TraceViz
   class Logger
-    COLORS = {
-      reset: "\e[0m",
-      info: "\e[34m",
-      success: "\e[32m",
-      error: "\e[31m",
-      warn: "\e[33m",
-      start: "\e[36m",
-      finish: "\e[35m",
-    }.freeze
-
-    EMOJIS = {
-      info: "ℹ️",
-      success: "✅",
-      error: "❌",
-      warn: "⚠️",
-      start: "🚀",
-      finish: "🏁",
-    }.freeze
-
-    LEVELS = [:info, :success, :error, :warn, :start, :finish].freeze
+    LEVELS = Defaults.action_colors.keys.freeze
 
     def initialize(output: $stdout)
       @output = output
     end
 
-    def info(message)
-      log(:info, message)
+    LEVELS.each do |level|
+      define_method(level) do |message|
+        log(message, level)
+      end
     end
 
-    def success(message)
-      log(:success, message)
-    end
+    def log(message, level = :default)
+      validate_message!(message)
+      validate_level!(level)
 
-    def error(message)
-      log(:error, message)
-    end
+      color = color_for(level)
+      emoji = emoji_for(level)
 
-    def warn(message)
-      log(:warn, message)
+      raw_message = build_message(message, level, emoji)
+      formatted_message = wrap_in_color(raw_message, color)
+
+      @output.puts(formatted_message)
     end
 
-    def start(message)
-      log(:start, message)
+    private
+
+    def validate_message!(message)
+      raise ArgumentError, "Message must be a String" unless message.is_a?(String)
     end
 
-    def finish(message)
-      log(:finish, message)
+    def validate_level!(level)
+      raise ArgumentError, "Invalid log level: #{level}" unless LEVELS.include?(level)
     end
 
-    private
+    def color_for(level)
+      color_key = Defaults.action_colors.fetch(level)
+      Defaults.colors.fetch(color_key)
+    end
 
-    def log(level, message)
-      return unless LEVELS.include?(level)
+    def default_color
+      color_for(:default)
+    end
 
-      color = COLORS[level] || COLORS[:info]
-      emoji = EMOJIS[level] || EMOJIS[:info]
+    def emoji_for(level)
+      Defaults.action_emojis.fetch(level, "")
+    end
 
-      # Align emoji and level using fixed-width columns
-      formatted_message = format(
-        "#{color}%-3s %-8s#{COLORS[:reset]} %s",
-        emoji,
-        "[#{level.to_s.upcase}]",
-        message,
-      )
+    def build_message(message, level, emoji)
+      level_str = level == :default ? "" : "[#{level.to_s.upcase}]"
+      merged_emoji_level = "#{emoji} #{level_str}".strip
+      format("%-12s %s", merged_emoji_level, message)
+    end
 
-      @output.puts(formatted_message)
+    def wrap_in_color(message, color)
+      "#{color}#{message}#{default_color}"
     end
   end
 end

data/lib/trace_viz/loggers/trace_builder.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "trace_viz/loggers/trace_formatters/method_call_formatter"
+require "trace_viz/loggers/trace_formatters/method_return_formatter"
+
+module TraceViz
+  module Loggers
+    class TraceBuilder
+      FORMATTERS = {
+        call: TraceFormatters::MethodCallFormatter,
+        return: TraceFormatters::MethodReturnFormatter,
+      }.freeze
+
+      def initialize(trace_data)
+        @trace_data = trace_data
+      end
+
+      def build
+        formatter_class = FORMATTERS[trace_data.event]
+        raise ArgumentError, "No formatter found for #{trace_data.event}" unless formatter_class
+
+        formatter_class.new(trace_data).format
+      end
+
+      private
+
+      attr_reader :trace_data
+    end
+  end
+end

data/lib/trace_viz/loggers/trace_formatters/base_formatter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "trace_viz/formatters/base_formatter"
+require "trace_viz/utils/colorize"
+
+module TraceViz
+  module Loggers
+    module TraceFormatters
+      class BaseFormatter < TraceViz::Formatters::BaseFormatter
+        private
+
+        def colorize(text, *styles)
+          Utils::Colorize.colorize(text, *styles)
+        end
+
+        def formatted_method_name
+          return unless config.general[:show_method_name]
+
+          "#{formatted_class_name}#{formatted_action_name}"
+        end
+
+        def formatted_class_name
+          colorize("#{trace_data.klass}#", :bold, :yellow)
+        end
+
+        def formatted_action_name
+          colorize(trace_data.action, :light_cyan)
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/loggers/trace_formatters/method_call_formatter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "base_formatter"
+
+module TraceViz
+  module Loggers
+    module TraceFormatters
+      class MethodCallFormatter < BaseFormatter
+        def format
+          [
+            indent_representation,
+            colorize(depth_representation, :blue),
+            formatted_method_name,
+            colorize(source_location_representation, :dark_gray),
+            colorize(params_representation, :light_yellow),
+          ].compact.join(" ")
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/loggers/trace_formatters/method_return_formatter.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "base_formatter"
+
+module TraceViz
+  module Loggers
+    module TraceFormatters
+      class MethodReturnFormatter < BaseFormatter
+        def format
+          [
+            indent_representation,
+            colorize(depth_representation, :blue),
+            formatted_method_name,
+            colorize(result_representation, :cyan),
+            colorize(source_location_representation, :dark_gray),
+            colorize(execution_time_representation, :red),
+          ].compact.join(" ")
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/loggers/trace_logger.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "trace_builder"
+
+module TraceViz
+  module Loggers
+    class TraceLogger
+      LOG_LEVELS = {
+        call: :start,
+        return: :finish,
+      }.freeze
+
+      class << self
+        def log(trace_data)
+          new(trace_data).log
+        end
+      end
+
+      def initialize(trace_data)
+        @logger = TraceViz.logger
+        @trace_data = trace_data
+      end
+
+      def log
+        log_level = LOG_LEVELS[trace_data.event] || :info
+        logger.send(log_level, formatted_message)
+      end
+
+      private
+
+      attr_reader :logger, :trace_data
+
+      def formatted_message
+        Loggers::TraceBuilder.new(trace_data).build
+      end
+    end
+  end
+end

data/lib/trace_viz/loggers/trace_stats_logger.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "trace_builder"
+
+module TraceViz
+  module Loggers
+    class TraceStatsLogger
+      class << self
+        def log(collector)
+          new(collector).log
+        end
+      end
+
+      def initialize(collector)
+        @logger = TraceViz.logger
+        @stats = collector.stats
+      end
+
+      def log
+        logger.stats(formatted_stats)
+      end
+
+      private
+
+      attr_reader :logger, :stats
+
+      def formatted_stats
+        event_counts = stats.event_counts.map { |event, count| "#{event.capitalize}: #{count}" }.join(", ")
+        "Total Traces: #{stats.total_traces} | Max Depth: #{stats.max_depth} | Event Counts: [#{event_counts}]"
+      end
+    end
+  end
+end

data/lib/trace_viz/trace_data/base.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "trace_viz/context"
+
+module TraceViz
+  module TraceData
+    class Base
+      attr_reader :config,
+        :timestamp
+      attr_accessor :depth
+
+      def initialize
+        @config = Context.for(:config).configuration
+
+        @depth = 0
+        record_timestamp
+      end
+
+      # Unique ID for each individual event
+      def id
+        raise NotImplementedError
+      end
+
+      # Shared ID betweem events for the same method call
+      def action_id
+        raise NotImplementedError
+      end
+
+      def action
+        raise NotImplementedError
+      end
+
+      def event
+        raise NotImplementedError
+      end
+
+      def path
+        raise NotImplementedError
+      end
+
+      def line_number
+        raise NotImplementedError
+      end
+
+      def klass
+        raise NotImplementedError
+      end
+
+      private
+
+      def record_timestamp
+        @timestamp = Time.now
+      end
+    end
+  end
+end

data/lib/trace_viz/trace_data/trace_point/base.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative "../base"
+
+module TraceViz
+  module TraceData
+    module TracePoint
+      class Base < TraceData::Base
+        attr_reader :trace_point,
+          :id,
+          :action_id,
+          :event,
+          :klass,
+          :action,
+          :path,
+          :line_number
+
+        def initialize(trace_point)
+          super()
+
+          @trace_point = trace_point
+
+          populate_trace_attributes
+          assign_ids
+        end
+
+        def duration
+          # TODO: Implement duration calculation
+        end
+
+        private
+
+        def populate_trace_attributes
+          @event = trace_point.event
+          @klass = trace_point.defined_class
+          @action = trace_point.callee_id
+          @path = trace_point.path
+          @line_number = trace_point.lineno
+        end
+
+        def assign_ids
+          @id = generate_unique_id
+          @action_id = generate_action_id
+        end
+
+        def memory_id
+          trace_point.self.object_id
+        end
+
+        def generate_unique_id
+          [
+            memory_id,
+            action,
+            path,
+            line_number,
+          ].join("_")
+        end
+
+        def generate_action_id
+          [
+            memory_id,
+            action,
+          ].join("_")
+        end
+      end
+    end
+  end
+end