trace_viz 0.0.1 → 1.0.0

data/lib/trace_viz/defaults/colors.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module TraceViz
+  module Defaults
+    class Colors
+      COLORS = {
+        reset: "\e[0m",
+        bold: "\e[1m",
+        dim: "\e[2m",
+        italic: "\e[3m",
+        underline: "\e[4m",
+        reverse: "\e[7m",
+        hidden: "\e[8m",
+        strikethrough: "\e[9m",
+      }
+
+      # Reference ASCII color codes
+      # https://talyian.github.io/ansicolors/
+
+      # Map 256-color ANSI codes
+      (0..255).each do |i|
+        COLORS["color_#{i}".to_sym] = "\e[38;5;#{i}m"
+      end
+
+      # To add background colors
+      (0..255).each do |i|
+        COLORS["bg_color_#{i}".to_sym] = "\e[48;5;#{i}m"
+      end
+
+      # Predefined names
+      COLORS.merge!({
+        black: "\e[30m",
+        red: "\e[31m",
+        green: "\e[32m",
+        yellow: "\e[33m",
+        blue: "\e[34m",
+        magenta: "\e[35m",
+        cyan: "\e[36m",
+        white: "\e[37m",
+        bright_black: "\e[90m",
+        bright_red: "\e[91m",
+        bright_green: "\e[92m",
+        bright_yellow: "\e[93m",
+        bright_blue: "\e[94m",
+        bright_magenta: "\e[95m",
+        bright_cyan: "\e[96m",
+        bright_white: "\e[97m",
+      })
+
+      class << self
+        def all
+          COLORS
+        end
+
+        def fetch(color)
+          COLORS.fetch(color, COLORS[:reset])
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/defaults/config.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module TraceViz
+  module Defaults
+    class Config
+      DEFAULTS = {
+        general: {
+          tab_size: 2,
+          mode: :summary, # :summary, :verbose
+          group_keys: [:event, :klass, :action],
+          show_indent: true,
+          show_depth: true,
+          max_display_depth: 3,
+          show_method_name: true,
+        },
+        source_location: {
+          show: false,
+          truncate_length: 100,
+        },
+        params: {
+          show: true,
+          mode: :name_and_value,
+          truncate_values: 10,
+        },
+        result: {
+          show: true,
+          truncate_length: 50,
+        },
+        execution: {
+          show_time: true,
+          show_trace_events: [:call, :return],
+        },
+        filters: [
+          :exclude_internal_call,
+          # :exclude_default_classes,
+          # :exclude_rails_framework,
+          # include_classes: {
+          #   classes: [],
+          # },
+          # exclude_classes: {
+          #   classes: [],
+          # },
+          # include_gems: {
+          #   app_running: true,
+          #   app_path: Dir.pwd,
+          #   gems: [],
+          # },
+          # exclude_gems: {
+          #   gems: [],
+          # },
+        ],
+        log: {
+          enabled: true,
+          runtime: false,
+          post_collection: true,
+          stats: true,
+        },
+        export: {
+          enabled: true,
+          path: "tmp",
+          format: :txt,
+          overwrite: false,
+        },
+      }.freeze
+
+      class << self
+        def fetch
+          DEFAULTS.dup
+        end
+
+        def valid_param_modes
+          [:name_and_value, :name_only, :value_only].freeze
+        end
+
+        def valid_param_mode?(mode)
+          valid_param_modes.include?(mode)
+        end
+
+        def valid_export_formats
+          [:txt, :json, :yaml].freeze
+        end
+
+        def valid_export_format?(format)
+          valid_export_formats.include?(format)
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/defaults/themes.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module TraceViz
+  module Defaults
+    class Themes
+      SOLARIZED = {
+        base03: :color_234,
+        base02: :color_235,
+        base01: :color_240,
+        base00: :color_241,
+        base0: :color_244,
+        base1: :color_245,
+        base2: :color_254,
+        base3: :color_230,
+        yellow: :color_136,
+        orange: :color_166,
+        red: :color_160,
+        magenta: :color_125,
+        violet: :color_61,
+        blue: :color_33,
+        cyan: :color_37,
+        green: :color_64,
+      }.freeze
+
+      class << self
+        def solarized
+          SOLARIZED
+        end
+
+        def apply_solarized_theme
+          colors = {
+            default: SOLARIZED[:base0],
+            info: SOLARIZED[:blue],
+            success: SOLARIZED[:green],
+            error: SOLARIZED[:red],
+            warn: SOLARIZED[:yellow],
+            start: SOLARIZED[:blue],
+            processing: SOLARIZED[:base01],
+            finish: SOLARIZED[:magenta],
+            exported: SOLARIZED[:green],
+            skipped: SOLARIZED[:base01],
+            stats: [:bold, :underline, SOLARIZED[:base2]],
+            trace_indent: SOLARIZED[:base03],
+            trace_depth: SOLARIZED[:blue],
+            trace_depth_prefix: [:italic, SOLARIZED[:base02]],
+            trace_depth_open: SOLARIZED[:base02],
+            trace_depth_value: SOLARIZED[:red],
+            trace_depth_close: SOLARIZED[:base03],
+            trace_method_name: SOLARIZED[:cyan],
+            trace_method_class: [:bold, SOLARIZED[:green]],
+            trace_method_sign: SOLARIZED[:violet],
+            trace_method_action: [:bold, SOLARIZED[:blue]],
+            trace_source_location: SOLARIZED[:base01],
+            trace_params_key: SOLARIZED[:orange],
+            trace_params_value: SOLARIZED[:base00],
+            trace_result_prefix: SOLARIZED[:base1],
+            trace_result_value: SOLARIZED[:base3],
+            trace_execution_time: SOLARIZED[:cyan],
+          }
+
+          Defaults.action_colors = colors
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/defaults.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "defaults/config"
+require_relative "defaults/colors"
+require_relative "defaults/themes"
+require_relative "defaults/actions"
+
+module TraceViz
+  module Defaults
+    @action_colors = Actions::COLORS.dup
+
+    class << self
+      attr_reader :action_colors
+
+      def action_colors=(new_colors)
+        @action_colors.merge!(new_colors)
+      end
+    end
+  end
+end

data/lib/trace_viz/exporters/base_exporter.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "trace_viz/helpers"
+require "trace_viz/shared"
+
+module TraceViz
+  module Exporters
+    class BaseExporter
+      include Helpers::ConfigHelper
+      include Shared::RendererHelper
+
+      def initialize(collector)
+        @export_config = config.export
+        @logger = config.logger
+
+        @collector = collector
+      end
+
+      def export
+        unless export_enabled?
+          logger.warn("Export is disabled in configuration. Skipping export process.")
+          return
+        end
+
+        ensure_directory_exists
+        return if handle_empty_content == :skip
+        return if handle_existing_file == :skip
+
+        write_file(content)
+
+        logger.exported("Data successfully exported to #{file_path}")
+      end
+
+      private
+
+      attr_reader :export_config, :logger, :collector
+
+      def content
+        raise NotImplementedError
+      end
+
+      def export_enabled?
+        export_config[:enabled]
+      end
+
+      def ensure_directory_exists
+        FileUtils.mkdir_p(File.dirname(file_path))
+      end
+
+      def handle_existing_file
+        return unless File.exist?(file_path)
+
+        if export_config[:overwrite]
+          logger.processing("Overwriting existing file: #{file_path}")
+        else
+          logger.skipped("File already exists and overwrite is disabled: #{file_path}. Export skipped.")
+          :skip
+        end
+      end
+
+      def handle_empty_content
+        if content.nil? || content.strip.empty?
+          logger.skipped("Export content is empty. Export skipped.")
+          :skip
+        end
+      end
+
+      def file_path
+        format = export_config[:format]
+        path = export_config[:path]
+
+        "#{path}/trace_output.#{format}"
+      end
+
+      def write_file(data)
+        File.write(file_path, data)
+      end
+    end
+  end
+end

data/lib/trace_viz/exporters/export_manager.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "trace_viz/helpers"
+require_relative "registry"
+
+module TraceViz
+  module Exporters
+    class ExportManager
+      include Helpers::ConfigHelper
+
+      def export(collector)
+        return unless export_enabled?
+
+        exporter = build_exporter(collector)
+        exporter.export
+      end
+
+      private
+
+      def build_exporter(collector)
+        Registry.build(export_format, collector)
+      end
+
+      def export_format
+        config.export[:format]
+      end
+
+      def export_enabled?
+        config.export[:enabled]
+      end
+    end
+  end
+end

data/lib/trace_viz/exporters/registry.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "text_exporter"
+
+module TraceViz
+  module Exporters
+    class Registry
+      EXPORTS = {
+        txt: TextExporter,
+      }
+
+      class << self
+        def build(format, *options)
+          raise ArgumentError unless supported_formats.include?(format)
+
+          EXPORTS[format].new(*options)
+        end
+
+        def supported_formats
+          EXPORTS.keys
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/exporters/text_exporter.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "base_exporter"
+require "trace_viz/renderers/renderer_factory"
+require "trace_viz/renderers/render_context"
+require "trace_viz/formatters/export/formatter_factory"
+
+module TraceViz
+  module Exporters
+    class TextExporter < BaseExporter
+      def initialize(collector)
+        super(collector)
+
+        @renderer = build_renderer(collector, Formatters::Export::FormatterFactory)
+      end
+
+      private
+
+      attr_reader :renderer
+
+      def content
+        data.join("\n")
+      end
+
+      def data
+        process_lines(renderer.to_lines) { |line| process_line(line) }
+      end
+
+      def process_line(line)
+        [
+          line[:line],
+          *process_lines(line[:nested_lines]) { |nested| process_line(nested) },
+        ].compact
+      end
+    end
+  end
+end

data/lib/trace_viz/formatters/base_formatter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "trace_viz/helpers"
+
+module TraceViz
+  module Formatters
+    class BaseFormatter
+      include Helpers::ConfigHelper
+
+      def call
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/trace_viz/formatters/export/base_formatter.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "../trace_data_formatter"
+
+module TraceViz
+  module Formatters
+    module Export
+      class BaseFormatter < TraceDataFormatter
+      end
+    end
+  end
+end

data/lib/trace_viz/formatters/export/formatter_factory.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "method_call_formatter"
+require_relative "method_return_formatter"
+require_relative "summary_group_formatter"
+
+module TraceViz
+  module Formatters
+    module Export
+      class FormatterFactory
+        FORMATTERS = {
+          call: MethodCallFormatter.new,
+          return: MethodReturnFormatter.new,
+          summary_group: SummaryGroupFormatter.new,
+        }.freeze
+
+        class << self
+          def fetch_formatter(key)
+            FORMATTERS.fetch(key) do
+              raise ArgumentError, "Unsupported factory key: #{key}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/formatters/export/method_call_formatter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "base_formatter"
+
+module TraceViz
+  module Formatters
+    module Export
+      class MethodCallFormatter < BaseFormatter
+        def call(trace_data)
+          [
+            indent_representation(trace_data),
+            depth_representation(trace_data),
+            method_name_representation(trace_data),
+            source_location_representation(trace_data),
+            params_representation(trace_data),
+          ].compact.join(" ")
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/formatters/export/method_return_formatter.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "base_formatter"
+
+module TraceViz
+  module Formatters
+    module Export
+      class MethodReturnFormatter < BaseFormatter
+        def call(trace_data)
+          [
+            indent_representation(trace_data),
+            depth_representation(trace_data),
+            method_name_representation(trace_data),
+            result_representation(trace_data),
+            source_location_representation(trace_data),
+            execution_time_representation(trace_data),
+          ].compact.join(" ")
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/formatters/export/summary_group_formatter.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "base_formatter"
+
+module TraceViz
+  module Formatters
+    module Export
+      class SummaryGroupFormatter < BaseFormatter
+        include Helpers::Summary::ParamsHelper
+        include Helpers::Summary::SourceHelper
+
+        def call(trace_data)
+          [
+            indent_representation(trace_data),
+            depth_representation(trace_data),
+            Defaults::Actions.emoji_for(:processing),
+            method_name_representation(trace_data),
+            source_location_representation(trace_data),
+            format_params_template(trace_data, config),
+            summary_info(trace_data),
+          ].compact.join(" ")
+        end
+
+        private
+
+        def summary_info(trace_data)
+          "[Summary: #{trace_data.count} calls | Avg Time: #{format(
+            "in %.6fms",
+            trace_data.average_duration,
+          )}]"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module TraceViz
+  module Formatters
+    module Helpers
+      module DepthHelper
+        def depth_representation(trace_data)
+          return unless config.general[:show_depth]
+
+          "depth[#{trace_data.depth}]"
+        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(trace_data)
+          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/log/color_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "trace_viz/utils/colorize"
+
+module TraceViz
+  module Formatters
+    module Helpers
+      module Log
+        module ColorHelper
+          def colorize_for(text, action)
+            colors = Defaults::Actions.colors_for(action)
+
+            colorize(text, *colors)
+          end
+
+          def colorize(text, *colors)
+            Utils::Colorize.colorize(text, *colors)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module TraceViz
+  module Formatters
+    module Helpers
+      module Log
+        module DepthHelper
+          def format_depth(trace_data, config)
+            return unless config.general[:show_depth]
+
+            prefix = colorize_for("depth", :trace_depth_prefix)
+            open_block = colorize_for("[", :trace_depth_open)
+            number = colorize_for(trace_data.depth, :trace_depth_value)
+            close_block = colorize_for("]", :trace_depth_close)
+
+            [prefix, open_block, number, close_block].join
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/formatters/helpers/log/method_name_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module TraceViz
+  module Formatters
+    module Helpers
+      module Log
+        module MethodNameHelper
+          def format_method_name(trace_data, config)
+            return unless config.general[:show_method_name]
+
+            "#{format_class_name(trace_data)}#{format_action_name(trace_data)}"
+          end
+
+          private
+
+          def format_class_name(trace_data)
+            klass = colorize_for(trace_data.klass, :trace_method_class)
+            method_sign = colorize_for("#", :trace_method_sign)
+            [klass, method_sign].join
+          end
+
+          def format_action_name(trace_data)
+            colorize_for(trace_data.action, :trace_method_action)
+          end
+        end
+      end
+    end
+  end
+end