trace_viz 1.0.0 → 1.0.1

data/lib/trace_viz/utils/alias_generator.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module TraceViz
+  module Utils
+    class AliasGenerator
+      COMPONENT_DELIMITER = "::"
+      ALIAS_DELIMITER = "_"
+
+      class << self
+        #
+        # Generates a unique alias for a given name and ensures it doesn't conflict
+        # with existing aliases.
+        #
+        def generate(name:, assigned_aliases:)
+          raise ArgumentError, "name cannot be nil" if name.nil?
+
+          # Break the name into components and extract initials
+          alias_candidate = extract_initials(name.to_s)
+
+          # Ensure the alias is unique
+          unique_alias = ensure_unique_alias(
+            candidate: alias_candidate,
+            assigned_aliases: assigned_aliases,
+            original_name: name,
+          )
+
+          # Record the alias in the map
+          assigned_aliases[name] = unique_alias
+          unique_alias
+        end
+
+        private
+
+        #
+        # Extracts initials from a namespaced string
+        #
+        def extract_initials(full_name)
+          parts = full_name.split(COMPONENT_DELIMITER)
+          initials = parts.map { |part| part.scan(/[A-Z]/).join }
+          initials.join(ALIAS_DELIMITER)
+        end
+
+        #
+        # Ensures the alias is unique by appending a counter if necessary
+        #
+        def ensure_unique_alias(candidate:, assigned_aliases:, original_name:)
+          unique_alias = candidate
+          counter = 1
+          while assigned_aliases.value?(unique_alias)
+            unique_alias = "#{candidate}#{ALIAS_DELIMITER}#{counter}"
+            counter += 1
+          end
+          unique_alias
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/utils/format/key_value_formatter.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module TraceViz
+  module Utils
+    module Format
+      module KeyValueFormatter
+        DEFAULT_MODE = :name_and_value
+        VALID_MODES = [:name_and_value, :name_only, :value_only].freeze
+
+        class << self
+          def format_pairs(data, mode: DEFAULT_MODE)
+            validate_input(data)
+            formatter = build_formatter(mode)
+            data.map { |key, value| formatter.call(key, value) }.join(", ")
+          end
+
+          private
+
+          def validate_input(data)
+            raise ArgumentError,
+              "Expected a Hash for data, but received #{data.class}. Please pass a valid Hash." unless data.is_a?(Hash)
+          end
+
+          def build_formatter(mode)
+            unless VALID_MODES.include?(mode)
+              raise ArgumentError, "Invalid mode: #{mode}. Valid modes are: #{VALID_MODES.join(", ")}."
+            end
+
+            case mode
+            when :name_and_value
+              ->(key, value) { "#{key}: #{value}" }
+            when :name_only
+              ->(key, _) { key.to_s }
+            when :value_only
+              ->(_, value) { value.to_s }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/utils/format/value_truncator.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module TraceViz
+  module Utils
+    module Format
+      module ValueTruncator
+        DEFAULT_LENGTH = -1
+        VALID_DIRECTIONS = [:start, :end].freeze
+
+        class << self
+          def truncate(value, length: DEFAULT_LENGTH, direction: :end, hash_length: DEFAULT_LENGTH)
+            validate_params(length, direction, hash_length)
+
+            # Skip truncation if length is not positive
+            return value unless length.positive?
+
+            opts = {
+              value: value,
+              length: length,
+              direction: direction,
+              hash_length: hash_length,
+            }
+
+            case value
+            when String then truncate_string(opts)
+            when Array then truncate_array(opts)
+            when Hash then truncate_hash(opts)
+            else truncate_object(opts)
+            end
+          end
+
+          private
+
+          def validate_params(length, direction, hash_length)
+            validate_length(length)
+            validate_length(hash_length)
+            validate_direction(direction)
+          end
+
+          def validate_length(val)
+            return if val.is_a?(Integer) && (val.positive? || val == DEFAULT_LENGTH)
+
+            raise ArgumentError, "Invalid length: #{val}. Must be a positive Integer or -1."
+          end
+
+          def validate_direction(direction)
+            return if VALID_DIRECTIONS.include?(direction)
+
+            raise ArgumentError, "Invalid direction: #{direction}. Valid options are :start or :end."
+          end
+
+          def truncate_string(opts)
+            string = opts[:value]
+            length = opts[:length]
+            direction = opts[:direction]
+
+            return string if string.length <= length
+
+            case direction
+            when :start then "...#{string[-length..]}"
+            when :end then "#{string[0, length]}..."
+            end
+          end
+
+          def truncate_array(opts)
+            array = opts[:value]
+            length = opts[:length]
+
+            return array if array.size <= length
+
+            truncated = array.take(length)
+            truncated << "..." if array.size > length
+            truncated
+          end
+
+          def truncate_hash(opts)
+            hash = opts[:value]
+            length = opts[:length]
+            direction = opts[:direction]
+            hash_length = opts[:hash_length]
+
+            truncated_keys = hash.keys.take(length)
+
+            truncated_parts = truncated_keys.map do |key|
+              "#{key}: #{truncate(hash[key], **opts.except(:value))}"
+            end
+
+            truncated_parts << "..." if hash.size > length
+            format_hash(
+              content: truncated_parts.join(", "),
+              direction: direction,
+              hash_length: hash_length,
+            )
+          end
+
+          def format_hash(content:, direction:, hash_length:)
+            # Only truncate the final string if hash_length is positive
+            return "{#{content}}" unless hash_length.positive?
+
+            case direction
+            when :start then "{...#{content[-hash_length..]}}"
+            when :end then "{#{content[0, hash_length]}...}"
+            end
+          end
+
+          def truncate_object(opts)
+            object = opts[:value]
+            length = opts[:length]
+            direction = opts[:direction]
+
+            object_str = object.inspect
+            return object_str if object_str.length <= length
+
+            case direction
+            when :start then "#{object.class}(...#{object_str[-length..]})"
+            when :end then "#{object.class}(#{object_str[0, length]}...)"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trace_viz/utils.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, "utils/**/*.rb")].each { |file| require_relative file }
+
+module TraceViz
+  module Utils
+  end
+end

data/lib/trace_viz/version.rb

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

metadata

@@ -1,18 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: trace_viz
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Huy Nguyen
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-01-04 00:00:00.000000000 Z
+date: 2025-03-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
-  currently under development.\n"
+  \nin a block of code. Useful for debugging and logging.\n"
 email:
 - patrick204nqh@gmail.com
 executables: []
@@ -36,6 +35,10 @@ files:
 - lib/trace_viz.rb
 - lib/trace_viz/adapters/base_adapter.rb
 - lib/trace_viz/adapters/trace_point_adapter.rb
+- lib/trace_viz/builders/base_builder.rb
+- lib/trace_viz/builders/diagram/base_builder.rb
+- lib/trace_viz/builders/diagram/message_builder.rb
+- lib/trace_viz/builders/diagram/sequence_builder.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
@@ -87,9 +90,20 @@ files:
 - lib/trace_viz/errors.rb
 - lib/trace_viz/exporters/base_exporter.rb
 - lib/trace_viz/exporters/export_manager.rb
+- lib/trace_viz/exporters/mermaid_exporter.rb
 - lib/trace_viz/exporters/registry.rb
 - lib/trace_viz/exporters/text_exporter.rb
+- lib/trace_viz/extractors/base_extractor.rb
+- lib/trace_viz/extractors/diagram/base_extractor.rb
+- lib/trace_viz/extractors/diagram/box_extractor.rb
+- lib/trace_viz/extractors/diagram/message_extractor.rb
+- lib/trace_viz/extractors/diagram/participant_extractor.rb
+- lib/trace_viz/extractors/diagram/processors/message_processor.rb
 - lib/trace_viz/formatters/base_formatter.rb
+- lib/trace_viz/formatters/base_formatter_factory.rb
+- lib/trace_viz/formatters/diagram/sequence/base_formatter.rb
+- lib/trace_viz/formatters/diagram/sequence/message_formatter.rb
+- lib/trace_viz/formatters/diagram_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
@@ -97,6 +111,8 @@ files:
 - 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/digram/action_helper.rb
+- lib/trace_viz/formatters/helpers/digram/result_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
@@ -129,14 +145,22 @@ files:
 - 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/managers/diagram/participant_manager.rb
+- lib/trace_viz/models.rb
+- lib/trace_viz/models/box.rb
+- lib/trace_viz/models/diagram.rb
+- lib/trace_viz/models/message.rb
+- lib/trace_viz/models/participant.rb
 - lib/trace_viz/renderers/base_renderer.rb
+- lib/trace_viz/renderers/diagram/sequence_renderer.rb
 - lib/trace_viz/renderers/render_context.rb
+- lib/trace_viz/renderers/renderer_builder.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/syntax/mermaid/sequence_syntax.rb
 - lib/trace_viz/trace_data/base.rb
 - lib/trace_viz/trace_data/node.rb
 - lib/trace_viz/trace_data/root_node.rb
@@ -149,10 +173,13 @@ files:
 - lib/trace_viz/traits/depth_trackable.rb
 - lib/trace_viz/traits/identifiable.rb
 - lib/trace_viz/traits/time_trackable.rb
+- lib/trace_viz/transformers/base_transformer.rb
+- lib/trace_viz/transformers/summary_transformer.rb
+- lib/trace_viz/utils.rb
+- lib/trace_viz/utils/alias_generator.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/format/key_value_formatter.rb
+- lib/trace_viz/utils/format/value_truncator.rb
 - lib/trace_viz/utils/id_generator.rb
 - lib/trace_viz/version.rb
 - sig/adapters/base_adapter.rbs
@@ -185,7 +212,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
@@ -201,7 +228,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/renderers/summary/node_processor.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-require "trace_viz/trace_data/summary_node"
-
-module TraceViz
-  module Renderers
-    class NodeProcessor
-      def initialize(nodes, context)
-        @nodes = nodes
-        @context = context
-      end
-
-      def process
-        grouped_nodes.flat_map { |key, group| render_node_or_group(key, group) }
-      end
-
-      private
-
-      attr_reader :nodes, :context
-
-      def grouped_nodes
-        nodes.group_by { |node| node_key(node) }
-      end
-
-      def group_keys
-        context.group_keys
-      end
-
-      def node_key(node)
-        group_keys.map { |key| fetch_node_attribute(node, key) }
-      end
-
-      def fetch_node_attribute(node, key)
-        node.respond_to?(key) ? node.public_send(key) : nil
-      end
-
-      def render_node_or_group(key, group)
-        if group.size > 1
-          render_group(key, group)
-        else
-          render_single_node(group.first)
-        end
-      end
-
-      def render_group(key, group)
-        representative_node = group.first
-        nested_lines = process_nested_nodes(representative_node)
-
-        [{
-          line: format_group_line(group),
-          trace_data: representative_node,
-          nested_lines: nested_lines,
-        }]
-      end
-
-      def render_single_node(node)
-        current_line = {
-          line: format_node(node),
-          trace_data: node,
-          nested_lines: process_nested_nodes(node),
-        }
-
-        [current_line]
-      end
-
-      def process_nested_nodes(node)
-        return [] unless node.respond_to?(:children) && node.children.any?
-
-        NodeProcessor.new(node.children, context).process
-      end
-
-      def format_node(node)
-        context.fetch_formatter(node.event).call(node)
-      end
-
-      def format_group_line(group)
-        node = TraceData::SummaryNode.new(group: group)
-        context.fetch_formatter(:summary_group).call(node)
-      end
-    end
-  end
-end

data/lib/trace_viz/utils/format_utils/key_value_formatter.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module TraceViz
-  module Utils
-    module FormatUtils
-      class KeyValueFormatter
-        DEFAULT_MODE = :name_and_value
-
-        def initialize(mode: DEFAULT_MODE)
-          @mode = mode
-          @formatter = build_formatter
-        end
-
-        def call(data)
-          validate_input(data)
-          data.map { |key, value| @formatter.call(key, value) }.join(", ")
-        end
-
-        private
-
-        def validate_input(data)
-          unless data.is_a?(Hash)
-            raise ArgumentError, "Expected a Hash for key-value formatting, got #{data.class}"
-          end
-        end
-
-        def build_formatter
-          {
-            name_and_value: ->(key, value) { "#{key}: #{value}" },
-            name_only: ->(key, _) { key.to_s },
-            value_only: ->(_, value) { value.to_s },
-          }.fetch(@mode) { raise ArgumentError, "Invalid mode: #{@mode}" }
-        end
-      end
-    end
-  end
-end

data/lib/trace_viz/utils/format_utils/value_truncator.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-module TraceViz
-  module Utils
-    module FormatUtils
-      class ValueTruncator
-        DEFAULT_LENGTH = -1
-        VALID_DIRECTIONS = [:start, :end].freeze
-
-        def initialize(length: DEFAULT_LENGTH, direction: :end)
-          @length = length
-          @direction = validate_direction(direction)
-        end
-
-        def truncate(value)
-          return value unless valid_length?
-
-          case value
-          when String then truncate_string(value)
-          when Array then truncate_array(value)
-          when Hash then truncate_hash(value)
-          else truncate_generic(value)
-          end
-        end
-
-        private
-
-        attr_reader :length, :direction
-
-        def validate_direction(direction)
-          return direction if VALID_DIRECTIONS.include?(direction)
-
-          raise ArgumentError, "Invalid direction: #{direction}. Valid options are :start or :end."
-        end
-
-        def valid_length?
-          length.is_a?(Integer) && length.positive?
-        end
-
-        def truncate_string(string)
-          return string if string.length <= length
-
-          case direction
-          when :start then "...#{string[-length..]}"
-          when :end then "#{string[0, length]}..."
-          end
-        end
-
-        def truncate_array(array)
-          truncated = array.take(length)
-          truncated << "..." if array.size > length
-          truncated
-        end
-
-        def truncate_hash(hash)
-          keys = hash.keys.take(length)
-          truncated_pairs = keys.map { |key| "#{key}: #{truncate(hash[key])}" }
-          truncated_pairs << "..." if hash.size > length
-          "{#{truncated_pairs.join(", ")}}"
-        end
-
-        def truncate_generic(object)
-          object_str = object.inspect
-          return object_str if object_str.length <= length
-
-          case direction
-          when :start then "#{object.class}(...#{object_str[-length..]})"
-          when :end then "#{object.class}(#{object_str[0, length]}...)"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/trace_viz/utils/format_utils.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "format_utils/key_value_formatter"
-require_relative "format_utils/value_truncator"
-
-module TraceViz
-  module Utils
-    module FormatUtils
-      class << self
-        # Formats key-value pairs based on the provided mode
-        def format_key_value_pairs(data, mode)
-          formatter = KeyValueFormatter.new(mode: mode)
-          formatter.call(data)
-        end
-
-        # Truncates a value to the specified length
-        def truncate_value(value, length, direction: :end)
-          truncator = ValueTruncator.new(length: length, direction: direction)
-          truncator.truncate(value)
-        end
-      end
-    end
-  end
-end