trace_viz 0.0.1 → 1.0.0

data/sig/context/manager.rbs

@@ -0,0 +1,10 @@
+module TraceViz
+  module Context
+    class Manager
+      def self.enter_contexts: (Hash[Symbol, untyped] contexts) -> void
+      def self.exit_contexts: (*Symbol keys) -> void
+      def self.with_contexts: (?Hash[Symbol, untyped] contexts) { () -> void } -> void
+      def self.fetch_context: (Symbol key) -> untyped
+    end
+  end
+end

data/sig/context/map.rbs

@@ -0,0 +1,13 @@
+module TraceViz
+  module Context
+    class Map
+      @context_map: Hash[Symbol, untyped]
+
+      def initialize: () -> void
+      def replace: (Hash[Symbol, untyped] new_map) -> void
+      def fetch: (Symbol key) -> untyped
+      def remove: (*Symbol keys) -> void
+      def reset: () -> void
+    end
+  end
+end

data/sig/context.rbs

@@ -0,0 +1,5 @@
+module TraceViz
+  module Context
+    def self.for: (Symbol key) -> TraceViz::Context::Manager
+  end
+end

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,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: trace_viz
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Huy Nguyen
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-17 00:00:00.000000000 Z
+date: 2025-01-04 00:00:00.000000000 Z
 dependencies: []
-description: Trace method calls and attribute accesses within Ruby classes, collect
-  execution data, and visualize the results using Mermaid diagrams.
+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
+  currently under development.\n"
 email:
 - patrick204nqh@gmail.com
 executables: []
@@ -24,36 +25,159 @@ files:
 - ".vscode/launch.json"
 - ".vscode/settings.json"
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - 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/depth_manager.rb
-- lib/trace_viz/adapters/trace_point/event_handler.rb
-- lib/trace_viz/adapters/trace_point/trace_data.rb
-- lib/trace_viz/adapters/trace_point/trace_formatter.rb
-- lib/trace_viz/adapters/trace_point/trace_logger.rb
 - lib/trace_viz/adapters/trace_point_adapter.rb
+- lib/trace_viz/collectors/base_collector.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
+- lib/trace_viz/collectors/filters/exclude_internal_call_filter.rb
+- lib/trace_viz/collectors/filters/exclude_rails_framework_filter.rb
+- 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
+- lib/trace_viz/config/validator.rb
 - lib/trace_viz/configuration.rb
 - lib/trace_viz/context.rb
 - lib/trace_viz/context/base_context.rb
 - lib/trace_viz/context/config_context.rb
 - lib/trace_viz/context/manager.rb
-- lib/trace_viz/context/manager/context_map.rb
-- lib/trace_viz/context/manager/context_operations.rb
-- lib/trace_viz/context/manager/context_registry.rb
-- lib/trace_viz/context/manager/context_validation.rb
+- lib/trace_viz/context/map.rb
+- lib/trace_viz/context/registry.rb
+- lib/trace_viz/context/tracking/active_calls.rb
 - lib/trace_viz/context/tracking/depth.rb
 - lib/trace_viz/context/tracking_context.rb
 - 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/export_manager.rb
+- lib/trace_viz/exporters/registry.rb
+- lib/trace_viz/exporters/text_exporter.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/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
@@ -61,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
@@ -77,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/adapters/trace_point/depth_manager.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module TraceViz
-  module Adapters
-    module TracePoint
-      class DepthManager
-        def initialize(trace_data)
-          @trace_data = trace_data
-          @context = Context.for(:tracking)
-        end
-
-        def assign_depth
-          context_depth = context&.depth
-          return 0 unless context_depth
-
-          case trace_data.event
-          when :call
-            current_depth = context_depth.current || 0
-            context_depth.increment
-            current_depth
-          when :return
-            context_depth.decrement
-          else
-            0 # Disables depth tracking for other events
-          end
-        end
-
-        private
-
-        attr_reader :trace_data, :context
-      end
-    end
-  end
-end

data/lib/trace_viz/adapters/trace_point/event_handler.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module TraceViz
-  module Adapters
-    module TracePoint
-      class EventHandler
-        def initialize(trace_data)
-          @trace_data = trace_data
-        end
-
-        def handle
-          case trace_data.event
-          when :call
-            handle_call
-          when :return
-            handle_return
-          else
-            raise AdapterError, "Unknown event type #{trace_data.event}"
-          end
-        end
-
-        private
-
-        attr_reader :trace_data
-
-        def handle_call
-          trace_data.log_trace
-        end
-
-        def handle_return
-          trace_data.log_trace
-        end
-      end
-    end
-  end
-end

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

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-require "trace_viz/adapters/trace_point/depth_manager"
-
-module TraceViz
-  module Adapters
-    module TracePoint
-      class TraceData
-        attr_reader :trace_point, :config, :timestamp, :depth
-
-        def initialize(trace_point)
-          @trace_point = trace_point
-          @config = Context.for(:config).configuration
-          @logger = TraceLogger.new(self)
-          @depth_manager = DepthManager.new(self)
-
-          record_timestamp
-          assign_depth
-        end
-
-        def id
-          trace_point.method_id
-        end
-
-        def event
-          trace_point.event
-        end
-
-        def path
-          trace_point.path
-        end
-
-        def line_number
-          trace_point.lineno
-        end
-
-        def klass
-          trace_point.defined_class
-        end
-
-        def params
-          trace_point.binding.local_variables
-        end
-
-        def result
-          trace_point.return_value
-        end
-
-        def internal_call?
-          internal_path? || internal_class?
-        end
-
-        def exceeded_max_depth?
-          return false unless config.max_display_depth
-
-          depth > config.max_display_depth
-        end
-
-        def duration
-          # TODO: Implement duration calculation
-        end
-
-        def log_trace
-          logger.log_trace
-        end
-
-        private
-
-        attr_reader :logger, :depth_manager
-
-        def internal_path?
-          path.include?("<internal:")
-        end
-
-        def internal_class?
-          klass.to_s.start_with?("TracePoint")
-        end
-
-        def record_timestamp
-          @timestamp = Time.now
-        end
-
-        def assign_depth
-          @depth = @depth_manager.assign_depth
-        end
-      end
-    end
-  end
-end

data/lib/trace_viz/adapters/trace_point/trace_formatter.rb

@@ -1,95 +0,0 @@
-# frozen_string_literal: true
-
-require "trace_viz/utils/colorize"
-
-module TraceViz
-  module Adapters
-    module TracePoint
-      class TraceFormatter
-        def initialize(trace_data)
-          @trace_data = trace_data
-          @config = @trace_data.config
-          @logger = TraceViz.logger
-        end
-
-        def format_call
-          return "" if trace_data.exceeded_max_depth?
-
-          [
-            indent_if_enabled,
-            colorize(depth_if_enabled, :blue),
-            colorize(method_name_if_enabled, :light_green),
-            colorize(source_location_if_enabled, :dark_gray),
-            colorize(params_if_enabled, :yellow),
-          ].compact.join(" ")
-        end
-
-        def format_return
-          return "" if trace_data.exceeded_max_depth?
-
-          [
-            indent_if_enabled,
-            colorize(depth_if_enabled, :blue),
-            colorize(method_name_if_enabled, :light_green),
-            colorize(result_if_enabled, :cyan),
-            colorize(source_location_if_enabled, :dark_gray),
-            colorize(execution_time_if_enabled, :red),
-          ].compact.join(" ")
-        end
-
-        private
-
-        attr_reader :trace_data, :config, :logger
-
-        def indent_if_enabled
-          return unless config.show_indent && config.show_depth
-
-          " " * (config.tab_size * trace_data.depth)
-        end
-
-        def depth_if_enabled
-          return unless config.show_depth
-
-          "#depth:#{trace_data.depth}"
-        end
-
-        def method_name_if_enabled
-          return unless config.show_method_name
-
-          "#{trace_data.klass}##{trace_data.id}"
-        end
-
-        def source_location_if_enabled
-          return unless config.show_source_location
-
-          "at #{trace_data.path}:#{trace_data.line_number}"
-        end
-
-        def params_if_enabled
-          return unless config.show_params
-
-          param_values = trace_data.params.map do |var|
-            trace_data.trace_point.binding.local_variable_get(var).inspect
-          end.join(", ")
-          "(#{param_values})"
-        end
-
-        def result_if_enabled
-          return unless config.show_return_value
-
-          "#=> #{trace_data.result.inspect}"
-        end
-
-        def execution_time_if_enabled
-          return unless config.show_execution_time && trace_data.duration
-
-          "in #{trace_data.duration}ms"
-        end
-
-        def colorize(text, color_key)
-          Utils::Colorize.colorize(text, color_key)
-        end
-      end
-    end
-  end
-end