trace_viz 0.0.2 → 1.0.0

data/sig/core/tracer.rbs

@@ -0,0 +1,7 @@
+module TraceViz
+  module Core
+    class Tracer
+      def trace: (options: Hash[Symbol, untyped]) { () -> void } -> void
+    end
+  end
+end

data/sig/core.rbs

@@ -0,0 +1,4 @@
+module TraceViz
+  module Core
+  end
+end

data/sig/defaults.rbs

@@ -0,0 +1,17 @@
+module TraceViz
+  class Defaults
+    COLORS: Hash[Symbol, String]
+    ACTION_EMOJIS: Hash[Symbol, String]
+    ACTION_COLORS: Hash[Symbol, Symbol]
+    CONFIG: Hash[Symbol, untyped]
+    VALID_PARAM_MODES: Array[Symbol]
+    VALID_EXPORT_FORMATS: Array[Symbol]
+
+    def self.colors: () -> Hash[Symbol, String]
+    def self.action_colors: () -> Hash[Symbol, Symbol]
+    def self.action_emojis: () -> Hash[Symbol, String]
+    def self.fetch_defaults: () -> Hash[Symbol, untyped]
+    def self.valid_param_modes: () -> Array[Symbol]
+    def self.valid_export_formats: () -> Array[Symbol]
+  end
+end

data/sig/errors.rbs

@@ -0,0 +1,13 @@
+module TraceViz
+  class Error < StandardError
+  end
+
+  class ConfigurationError < Error
+  end
+
+  class AdapterError < Error
+  end
+
+  class ContextError < Error
+  end
+end

data/sig/logger.rbs

@@ -0,0 +1,33 @@
+module TraceViz
+  class Logger
+    # Constants
+    LEVELS: Array[Symbol]
+
+    # Constructor
+    def initialize: (output: IO) -> void
+
+    # Dynamic methods for each log level
+    def info: (String?) -> void
+    def success: (String?) -> void
+    def error: (String?) -> void
+    def warn: (String?) -> void
+    def start: (String?) -> void
+    def processing: (String?) -> void
+    def finish: (String?) -> void
+    def exported: (String?) -> void
+    def skipped: (String?) -> void
+    def stats: (String?) -> void
+    def default: (String?) -> void
+
+    # Public methods
+    def log: (String?, Symbol) -> void
+
+    # Private methods
+    private def validate_message!: (String?) -> void
+    private def validate_level!: (Symbol) -> void
+    private def colors_for: (Symbol) -> Array[Symbol]
+    private def emoji_for: (Symbol) -> String
+    private def build_message: (String?, Symbol, String) -> String
+    private def apply_colors: (String, Array[Symbol]) -> String
+  end
+end

data/sig/trace_viz.rbs

@@ -1,4 +1,3 @@
 module TraceViz
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  def self.trace: (options: Hash[Symbol, untyped]) { () -> untyped } -> untyped
 end

data/sig/utils/colorize.rbs

@@ -0,0 +1,8 @@
+module TraceViz
+  module Utils
+    module Colorize
+      def self.colorize: (String text, *Symbol colors) -> String?
+      private def self.build_color_sequence: (Array[Symbol] colors) -> String
+    end
+  end
+end

data/sig/utils/format_utils/key_value_formatter.rbs

@@ -0,0 +1,16 @@
+module TraceViz
+  module Utils
+    module FormatUtils
+      class KeyValueFormatter
+        DEFAULT_MODE: Symbol
+
+        def initialize: (mode: Symbol) -> void
+
+        def format: (Hash[untyped, untyped]) -> String
+
+        private def validate_input: (untyped) -> void
+        private def build_formatter: () -> Hash[Symbol, ^(untyped, untyped) -> String]
+      end
+    end
+  end
+end

data/sig/utils/format_utils/value_truncator.rbs

@@ -0,0 +1,19 @@
+module TraceViz
+  module Utils
+    module FormatUtils
+      class ValueTruncator
+        DEFAULT_LENGTH: Integer
+
+        def initialize: (length: Integer) -> void
+
+        def truncate: (String | Array[untyped] | Hash[untyped, untyped] | Object) -> (String | Array[untyped] | Hash[untyped, untyped] | Object)
+
+        private def valid_length?: () -> bool
+        private def truncate_string: (String) -> String
+        private def truncate_array: (Array[untyped]) -> Array[untyped]
+        private def truncate_hash: (Hash[untyped, untyped]) -> String
+        private def truncate_generic: (Object) -> String
+      end
+    end
+  end
+end

data/sig/utils/format_utils.rbs

@@ -0,0 +1,8 @@
+module TraceViz
+  module Utils
+    module FormatUtils
+      def self.format_key_value_pairs: (Hash[untyped, untyped] data, Symbol mode) -> String
+      def self.truncate_value: (untyped value, Integer length) -> untyped
+    end
+  end
+end

data/sig/version.rbs

@@ -0,0 +1,3 @@
+module TraceViz
+  VERSION: String
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trace_viz
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Huy Nguyen
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-26 00:00:00.000000000 Z
+date: 2025-01-04 00:00:00.000000000 Z
 dependencies: []
 description: "TraceViz is a Ruby library designed to trace and visualize events executed
   \nin a block of code. Useful for debugging and logging. \nDiagram generation is
@@ -29,17 +29,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
+- examples/eu_central_bank.rb
 - examples/example.cast
 - examples/example.rb
 - lib/trace_viz.rb
 - lib/trace_viz/adapters/base_adapter.rb
 - lib/trace_viz/adapters/trace_point_adapter.rb
 - lib/trace_viz/collectors/base_collector.rb
-- lib/trace_viz/collectors/depth_manager.rb
-- lib/trace_viz/collectors/evaluators/base_evaluator.rb
-- lib/trace_viz/collectors/evaluators/filter_evaluator.rb
-- lib/trace_viz/collectors/evaluators/hidden_evaluator.rb
+- lib/trace_viz/collectors/filters/base_class_filter.rb
+- lib/trace_viz/collectors/filters/base_exclude_filter.rb
 - lib/trace_viz/collectors/filters/base_filter.rb
+- lib/trace_viz/collectors/filters/base_include_filter.rb
 - lib/trace_viz/collectors/filters/exclude_classes_filter.rb
 - lib/trace_viz/collectors/filters/exclude_default_classes_filter.rb
 - lib/trace_viz/collectors/filters/exclude_gems_filter.rb
@@ -48,8 +49,20 @@ files:
 - lib/trace_viz/collectors/filters/include_classes_filter.rb
 - lib/trace_viz/collectors/filters/include_gems_filter.rb
 - lib/trace_viz/collectors/filters/registry.rb
+- lib/trace_viz/collectors/hierarchy_linker.rb
+- lib/trace_viz/collectors/matchers/base_matcher.rb
 - lib/trace_viz/collectors/matchers/trace_point_action_matcher.rb
 - lib/trace_viz/collectors/matchers/within_depth_matcher.rb
+- lib/trace_viz/collectors/steps.rb
+- lib/trace_viz/collectors/steps/assign_depth_for_call_step.rb
+- lib/trace_viz/collectors/steps/assign_depth_for_return_step.rb
+- lib/trace_viz/collectors/steps/base_step.rb
+- lib/trace_viz/collectors/steps/build_hierarchy_step.rb
+- lib/trace_viz/collectors/steps/hidden_step.rb
+- lib/trace_viz/collectors/steps/linking_step.rb
+- lib/trace_viz/collectors/steps/validation_step.rb
+- lib/trace_viz/collectors/trace_pipeline.rb
+- lib/trace_viz/collectors/trace_pipeline_builder.rb
 - lib/trace_viz/collectors/trace_point_collector.rb
 - lib/trace_viz/collectors/trace_stats.rb
 - lib/trace_viz/config/copier.rb
@@ -67,38 +80,104 @@ files:
 - lib/trace_viz/core.rb
 - lib/trace_viz/core/tracer.rb
 - lib/trace_viz/defaults.rb
+- lib/trace_viz/defaults/actions.rb
+- lib/trace_viz/defaults/colors.rb
+- lib/trace_viz/defaults/config.rb
+- lib/trace_viz/defaults/themes.rb
 - lib/trace_viz/errors.rb
 - lib/trace_viz/exporters/base_exporter.rb
-- lib/trace_viz/exporters/formatters/base_formatter.rb
-- lib/trace_viz/exporters/formatters/method_call_formatter.rb
-- lib/trace_viz/exporters/formatters/method_return_formatter.rb
+- lib/trace_viz/exporters/export_manager.rb
+- lib/trace_viz/exporters/registry.rb
 - lib/trace_viz/exporters/text_exporter.rb
-- lib/trace_viz/exporters/transformers/base_transformer.rb
-- lib/trace_viz/exporters/transformers/text_transformer.rb
 - lib/trace_viz/formatters/base_formatter.rb
+- lib/trace_viz/formatters/export/base_formatter.rb
+- lib/trace_viz/formatters/export/formatter_factory.rb
+- lib/trace_viz/formatters/export/method_call_formatter.rb
+- lib/trace_viz/formatters/export/method_return_formatter.rb
+- lib/trace_viz/formatters/export/summary_group_formatter.rb
+- lib/trace_viz/formatters/helpers.rb
 - lib/trace_viz/formatters/helpers/depth_helper.rb
 - lib/trace_viz/formatters/helpers/indent_helper.rb
+- lib/trace_viz/formatters/helpers/log/color_helper.rb
+- lib/trace_viz/formatters/helpers/log/depth_helper.rb
+- lib/trace_viz/formatters/helpers/log/method_name_helper.rb
+- lib/trace_viz/formatters/helpers/log/params_helper.rb
+- lib/trace_viz/formatters/helpers/log/result_helper.rb
+- lib/trace_viz/formatters/helpers/log/summary/params_helper.rb
 - lib/trace_viz/formatters/helpers/method_details_helper.rb
 - lib/trace_viz/formatters/helpers/params_helper.rb
 - lib/trace_viz/formatters/helpers/result_helper.rb
 - lib/trace_viz/formatters/helpers/source_helper.rb
+- lib/trace_viz/formatters/helpers/summary/params_helper.rb
+- lib/trace_viz/formatters/helpers/summary/source_helper.rb
 - lib/trace_viz/formatters/helpers/time_helper.rb
+- lib/trace_viz/formatters/log/base_formatter.rb
+- lib/trace_viz/formatters/log/formatter_factory.rb
+- lib/trace_viz/formatters/log/method_call_formatter.rb
+- lib/trace_viz/formatters/log/method_return_formatter.rb
+- lib/trace_viz/formatters/log/summary_group_formatter.rb
+- lib/trace_viz/formatters/log/verbose_formatter.rb
+- lib/trace_viz/formatters/trace_data_formatter.rb
+- lib/trace_viz/helpers.rb
+- lib/trace_viz/helpers/config_helper.rb
+- lib/trace_viz/helpers/trace_point/param_helper.rb
+- lib/trace_viz/helpers/tracking_helper.rb
 - lib/trace_viz/logger.rb
-- lib/trace_viz/loggers/trace_builder.rb
-- lib/trace_viz/loggers/trace_formatters/base_formatter.rb
-- lib/trace_viz/loggers/trace_formatters/method_call_formatter.rb
-- lib/trace_viz/loggers/trace_formatters/method_return_formatter.rb
+- lib/trace_viz/loggers/base_logger.rb
+- lib/trace_viz/loggers/log_level_resolver.rb
+- lib/trace_viz/loggers/logging_manager.rb
+- lib/trace_viz/loggers/post_collection_logger.rb
 - lib/trace_viz/loggers/trace_logger.rb
 - lib/trace_viz/loggers/trace_stats_logger.rb
+- lib/trace_viz/renderers/base_renderer.rb
+- lib/trace_viz/renderers/render_context.rb
+- lib/trace_viz/renderers/renderer_factory.rb
+- lib/trace_viz/renderers/summary/node_processor.rb
+- lib/trace_viz/renderers/summary_renderer.rb
+- lib/trace_viz/renderers/verbose_renderer.rb
+- lib/trace_viz/shared.rb
+- lib/trace_viz/shared/renderer_helper.rb
 - lib/trace_viz/trace_data/base.rb
+- lib/trace_viz/trace_data/node.rb
+- lib/trace_viz/trace_data/root_node.rb
+- lib/trace_viz/trace_data/summary_node.rb
 - lib/trace_viz/trace_data/trace_point/base.rb
 - lib/trace_viz/trace_data/trace_point/method_call.rb
 - lib/trace_viz/trace_data/trace_point/method_return.rb
 - lib/trace_viz/trace_data/trace_point_builder.rb
+- lib/trace_viz/traits.rb
+- lib/trace_viz/traits/depth_trackable.rb
+- lib/trace_viz/traits/identifiable.rb
+- lib/trace_viz/traits/time_trackable.rb
 - lib/trace_viz/utils/colorize.rb
 - lib/trace_viz/utils/format_utils.rb
+- lib/trace_viz/utils/format_utils/key_value_formatter.rb
+- lib/trace_viz/utils/format_utils/value_truncator.rb
+- lib/trace_viz/utils/id_generator.rb
 - lib/trace_viz/version.rb
+- sig/adapters/base_adapter.rbs
+- sig/adapters/trace_point_adapter.rbs
+- sig/collectors/filters/registry.rbs
+- sig/collectors/trace_point_collector.rbs
+- sig/config/copier.rbs
+- sig/config/validator.rbs
+- sig/configuration.rbs
+- sig/context.rbs
+- sig/context/base_context.rbs
+- sig/context/config_context.rbs
+- sig/context/manager.rbs
+- sig/context/map.rbs
+- sig/core.rbs
+- sig/core/tracer.rbs
+- sig/defaults.rbs
+- sig/errors.rbs
+- sig/logger.rbs
 - sig/trace_viz.rbs
+- sig/utils/colorize.rbs
+- sig/utils/format_utils.rbs
+- sig/utils/format_utils/key_value_formatter.rbs
+- sig/utils/format_utils/value_truncator.rbs
+- sig/version.rbs
 homepage: https://github.com/patrick204nqh/trace_viz
 licenses:
 - MIT
@@ -106,7 +185,7 @@ metadata:
   homepage_uri: https://github.com/patrick204nqh/trace_viz
   source_code_uri: https://github.com/patrick204nqh/trace_viz
   changelog_uri: https://github.com/patrick204nqh/trace_viz/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Trace method and attribute usage in Ruby classes and generate diagrams.
 test_files: []

data/lib/trace_viz/collectors/depth_manager.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module TraceViz
-  module Collectors
-    class DepthManager
-      def initialize
-        @tracker = Context.for(:tracking)
-      end
-
-      def align(trace_data)
-        case trace_data.event
-        when :call
-          push_to_call_stack(trace_data)
-        when :return
-          pop_from_call_stack(trace_data)
-        end
-        trace_data
-      end
-
-      private
-
-      attr_reader :tracker
-
-      # Increment the depth
-      def push_to_call_stack(trace_data)
-        trace_data.depth = tracker.current_depth
-        tracker.active_calls.push(trace_data)
-      end
-
-      # Decrement the depth
-      def pop_from_call_stack(trace_data)
-        tracker.active_calls.pop
-        trace_data.depth = tracker.current_depth
-      end
-    end
-  end
-end

data/lib/trace_viz/collectors/evaluators/base_evaluator.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require "trace_viz/context"
-
-module TraceViz
-  module Collectors
-    module Evaluators
-      class BaseEvaluator
-        def initialize
-          @config = Context.for(:config).configuration
-        end
-
-        def pass?(trace_data)
-          raise NotImplementedError
-        end
-
-        private
-
-        attr_reader :config
-      end
-    end
-  end
-end

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

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "trace_viz/formatters/base_formatter"
-
-module TraceViz
-  module Exporters
-    module Formatters
-      class BaseFormatter < TraceViz::Formatters::BaseFormatter
-      end
-    end
-  end
-end

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

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

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

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

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

@@ -1,25 +0,0 @@
-# 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

@@ -1,28 +0,0 @@
-# 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/loggers/trace_builder.rb

@@ -1,30 +0,0 @@
-# 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

@@ -1,32 +0,0 @@
-# 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

@@ -1,21 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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