trace_viz 0.0.2 → 1.0.0

data/lib/trace_viz/defaults.rb

@@ -1,138 +1,19 @@
 # frozen_string_literal: true
 
-module TraceViz
-  class Defaults
-    COLORS = {
-      reset: "\e[0m",
-      bold: "\e[1m",
-      dim: "\e[2m",
-      underline: "\e[4m",
-      reverse: "\e[7m",
-      black: "\e[30m",
-      red: "\e[31m",
-      green: "\e[32m",
-      yellow: "\e[33m",
-      blue: "\e[34m",
-      magenta: "\e[35m",
-      cyan: "\e[36m",
-      light_gray: "\e[37m",
-      dark_gray: "\e[90m",
-      light_red: "\e[91m",
-      light_green: "\e[92m",
-      light_yellow: "\e[93m",
-      light_blue: "\e[94m",
-      light_magenta: "\e[95m",
-      light_cyan: "\e[96m",
-      white: "\e[97m",
-      dim_light_gray: "\e[2;37m",
-    }.freeze
-
-    ACTION_EMOJIS = {
-      default: "",
-      info: "ℹ️",
-      success: "✅",
-      error: "❌",
-      warn: "⚠️",
-      start: "🚀",
-      processing: "🔄",
-      finish: "🏁",
-      exported: "📤",
-      skipped: "⏩",
-      stats: "📊",
-    }.freeze
-
-    ACTION_COLORS = {
-      default: :reset,
-      info: :cyan,
-      success: :green,
-      error: :light_red,
-      warn: :yellow,
-      start: :light_cyan,
-      processing: :dim_light_gray,
-      finish: :light_magenta,
-      exported: :light_green,
-      skipped: :dark_gray,
-      stats: :underline,
-    }.freeze
-
-    CONFIG = {
-      general: {
-        tab_size: 2,
-        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: 50,
-      },
-      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: [],
-        # },
-      ],
-      export: {
-        enabled: true,
-        path: "tmp",
-        format: :txt,
-        overwrite: false,
-      },
-    }.freeze
+require_relative "defaults/config"
+require_relative "defaults/colors"
+require_relative "defaults/themes"
+require_relative "defaults/actions"
 
-    VALID_PARAM_MODES = [:name_and_value, :name_only, :value_only].freeze
-    VALID_EXPORT_FORMATS = [:txt, :json, :yml].freeze
+module TraceViz
+  module Defaults
+    @action_colors = Actions::COLORS.dup
 
     class << self
-      def colors
-        COLORS
-      end
-
-      def action_colors
-        ACTION_COLORS
-      end
-
-      def action_emojis
-        ACTION_EMOJIS
-      end
-
-      def fetch_defaults
-        CONFIG.dup
-      end
-
-      def valid_param_modes
-        VALID_PARAM_MODES
-      end
+      attr_reader :action_colors
 
-      def valid_export_formats
-        VALID_EXPORT_FORMATS
+      def action_colors=(new_colors)
+        @action_colors.merge!(new_colors)
       end
     end
   end

data/lib/trace_viz/exporters/base_exporter.rb

@@ -1,18 +1,20 @@
 # frozen_string_literal: true
 
 require "fileutils"
-
-require "trace_viz/context"
-require_relative "transformers/text_transformer"
+require "trace_viz/helpers"
+require "trace_viz/shared"
 
 module TraceViz
   module Exporters
     class BaseExporter
+      include Helpers::ConfigHelper
+      include Shared::RendererHelper
+
       def initialize(collector)
-        @config = Context.for(:config).configuration
         @export_config = config.export
         @logger = config.logger
-        @data = transform_collector_data(collector)
+
+        @collector = collector
       end
 
       def export
@@ -32,12 +34,7 @@ module TraceViz
 
       private
 
-      attr_reader :config, :export_config, :logger, :data
-
-      def transform_collector_data(collector)
-        transformer = Transformers::TextTransformer.new(collector)
-        transformer.transform
-      end
+      attr_reader :export_config, :logger, :collector
 
       def content
         raise NotImplementedError

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

@@ -1,15 +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

@@ -1,42 +1,15 @@
 # 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"
+require "trace_viz/helpers"
 
 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::ConfigHelper
 
-      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
+      def call
         raise NotImplementedError
       end
-
-      private
-
-      attr_reader :trace_data, :config
     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

@@ -4,16 +4,10 @@ module TraceViz
   module Formatters
     module Helpers
       module DepthHelper
-        def depth_representation
+        def depth_representation(trace_data)
           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
+          "depth[#{trace_data.depth}]"
         end
       end
     end

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

@@ -4,7 +4,7 @@ module TraceViz
   module Formatters
     module Helpers
       module IndentHelper
-        def indent_representation
+        def indent_representation(trace_data)
           return unless config.general[:show_indent] && config.general[:show_depth]
 
           " " * (config.general[:tab_size] * trace_data.depth)

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

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "trace_viz/utils/format_utils"
+
+module TraceViz
+  module Formatters
+    module Helpers
+      module Log
+        module ParamsHelper
+          def format_params(trace_data, config)
+            return unless config.params[:show]
+
+            params = prepare_params(trace_data.params, config)
+            wrap_params(params, config)
+          end
+
+          private
+
+          def prepare_params(params, config)
+            params
+              .then { |p| truncate_values(p, config.params[:truncate_values]) }
+              .then { |p| colorize_keys_and_values(p) }
+              .then { |p| format_as_string(p, config.params[:mode]) }
+          end
+
+          def truncate_values(params, length)
+            return params unless length
+
+            params.transform_values { |value| Utils::FormatUtils.truncate_value(value, length) }
+          end
+
+          def colorize_keys_and_values(params)
+            params.transform_keys { |key| colorize_for(key.to_s, :trace_params_key) }
+              .transform_values { |value| colorize_for(value.to_s, :trace_params_value) }
+          end
+
+          def format_as_string(params, mode)
+            Utils::FormatUtils.format_key_value_pairs(params, mode)
+          end
+
+          def wrap_params(params_string, config)
+            return unless params_string
+
+            truncated = Utils::FormatUtils.truncate_value(params_string, config.params[:truncate_length])
+            "(#{truncated})"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "trace_viz/utils/format_utils"
+
+module TraceViz
+  module Formatters
+    module Helpers
+      module Log
+        module ResultHelper
+          def format_result(trace_data, config)
+            return unless config.result[:show]
+
+            truncated_result = Utils::FormatUtils.truncate_value(
+              trace_data.result.inspect,
+              config.result[:truncate_length],
+            )
+
+            prefix = colorize_for("#=>", :trace_result_prefix)
+            result = colorize_for(truncated_result, :trace_result_value)
+
+            [prefix, result].join(" ")
+          end
+        end
+      end
+    end
+  end
+end