trace_viz 0.0.1 → 0.0.2

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module TraceViz
+  module TraceData
+    module TracePoint
+      class MethodCall < Base
+        attr_reader :params
+
+        def initialize(trace_point)
+          super(trace_point)
+
+          populate_params
+        end
+
+        private
+
+        def populate_params
+          @params = extract_params(trace_point.binding)
+        end
+
+        def extract_params(binding)
+          method = binding.eval("method(:#{action})")
+          method.parameters.each_with_object({}) do |(_, name), hash|
+            next unless name
+            next if name.to_s.include?("*") # Skip invalid or special variable names
+
+            value = safe_local_variable_get(binding, name)
+            hash[name] = value
+          end
+        end
+
+        def safe_local_variable_get(binding, name)
+          binding.local_variable_defined?(name) ? binding.local_variable_get(name) : nil
+        rescue NameError
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module TraceViz
+  module TraceData
+    module TracePoint
+      class MethodReturn < Base
+        attr_reader :result
+
+        def initialize(trace_point)
+          super(trace_point)
+
+          populate_result
+        end
+
+        private
+
+        def populate_result
+          @result = @trace_point.return_value
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/trace_data/trace_point_builder.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "trace_point/method_call"
+require_relative "trace_point/method_return"
+
+module TraceViz
+  module TraceData
+    class TracePointBuilder
+      class << self
+        def build(tp)
+          case tp.event
+          when :call
+            TracePoint::MethodCall.new(tp)
+          when :return
+            TracePoint::MethodReturn.new(tp)
+          else
+            raise ArgumentError, "Unsupported TracePoint event: #{tp.event}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/utils/colorize.rb

@@ -3,31 +3,20 @@
 module TraceViz
   module Utils
     module Colorize
-      ANSI_COLORS = {
-        reset: "\e[0m",
-        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",
-      }.freeze
-
       class << self
-        def colorize(text, color)
-          return text unless text
+        def colorize(text, *styles)
+          return text if text.nil? || styles.empty?
+
+          "#{build_color_sequence(styles)}#{text}#{Defaults.colors[:reset]}"
+        end
+
+        private
 
-          "#{ANSI_COLORS[color]}#{text}#{ANSI_COLORS[:reset]}"
+        def build_color_sequence(styles)
+          styles
+            .map { |style| Defaults.colors[style] }
+            .compact
+            .join
         end
       end
     end

data/lib/trace_viz/utils/format_utils.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module TraceViz
+  module Utils
+    module FormatUtils
+      class << self
+        # Formats a hash or array of key-value pairs based on the specified mode
+        def format_key_value_pairs(data, mode)
+          data.map { |key, value| display_mode(mode).call(key, value) }.join(", ")
+        end
+
+        # Determines how key-value pairs are displayed based on the mode
+        def display_mode(mode)
+          {
+            name_and_value: ->(name, value) { "#{name}: #{value}" },
+            name_only: ->(name, _) { name.to_s },
+            value_only: ->(_, value) { value },
+          }.fetch(mode)
+        end
+
+        # Truncates a string or array to the specified length
+        def truncate_value(value, length)
+          return value unless length.is_a?(Integer) && length.positive?
+
+          case value
+          when String
+            truncate_string(value, length)
+          when Array
+            truncate_array(value, length)
+          when Hash
+            truncate_hash(value, length)
+          else
+            truncate_object(value, length)
+          end
+        end
+
+        private
+
+        def truncate_string(string, length)
+          string.length > length ? "#{string[0, length]}..." : string
+        end
+
+        def truncate_array(array, length)
+          truncated_array = array.take(length)
+          truncated_array << "..." if array.size > length
+          truncated_array
+        end
+
+        def truncate_hash(hash, length)
+          keys = hash.keys.take(length)
+          truncated_pairs = keys.map { |key| "#{key}: #{truncate_value(hash[key], length)}" }
+          truncated_pairs << "..." if hash.size > length
+          "{#{truncated_pairs.join(", ")}}"
+        end
+
+        def truncate_object(object, length)
+          object_string = object.inspect
+          if object.is_a?(Hash) || object.is_a?(Array)
+            truncate_value(object, length)
+          else
+            object_string.length > length ? "#{object.class}(#{object_string[0, length]}...)" : object_string
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TraceViz
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: trace_viz
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Huy Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-12-17 00:00:00.000000000 Z
+date: 2024-12-26 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,34 +25,78 @@ files:
 - ".vscode/launch.json"
 - ".vscode/settings.json"
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- 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/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_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/matchers/trace_point_action_matcher.rb
+- lib/trace_viz/collectors/matchers/within_depth_matcher.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/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/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/helpers/depth_helper.rb
+- lib/trace_viz/formatters/helpers/indent_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/time_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/trace_logger.rb
+- lib/trace_viz/loggers/trace_stats_logger.rb
+- lib/trace_viz/trace_data/base.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/utils/colorize.rb
+- lib/trace_viz/utils/format_utils.rb
 - lib/trace_viz/version.rb
 - sig/trace_viz.rbs
 homepage: https://github.com/patrick204nqh/trace_viz

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

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

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module TraceViz
-  module Adapters
-    module TracePoint
-      class TraceLogger
-        def initialize(trace_data)
-          @trace_data = trace_data
-          @config = @trace_data.config
-          @formatter = TraceFormatter.new(@trace_data)
-        end
-
-        def log_trace
-          return unless should_log?
-
-          case trace_data.event
-          when :call
-            log_call
-          when :return
-            log_return
-          end
-        end
-
-        private
-
-        attr_reader :trace_data, :config, :formatter
-
-        def log_call
-          formatted_call = formatter.format_call
-          TraceViz.logger.start(formatted_call)
-        end
-
-        def log_return
-          formatted_return = formatter.format_return
-          TraceViz.logger.finish(formatted_return)
-        end
-
-        def should_log?
-          config.show_trace_events.include?(trace_data.event)
-        end
-      end
-    end
-  end
-end

data/lib/trace_viz/context/manager/context_map.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module TraceViz
-  module Context
-    class Manager
-      module ContextMap
-        def get_context(key)
-          validate_key!(key)
-          @context_map[key]
-        end
-
-        def clear
-          @context_map.clear
-        end
-
-        def empty?
-          @context_map.empty?
-        end
-
-        def all_contexts
-          @context_map.map do |key, context|
-            {
-              key: key,
-              context: context,
-            }
-          end
-        end
-      end
-    end
-  end
-end