trace_viz 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dad6986e31d5fab4d42a7e6820086bd39ad16d3dd7461b483425d06122533d56
+  data.tar.gz: ca9411d76b1134ad5e676264771e7046a6e52fbe250040f61c5b3294071d2578
+SHA512:
+  metadata.gz: c66ab56494adc950558f5e9f21f8630178a262443440d70799ee43284ad03b0615e1031df8f24d495b9970b054c841c057d1858e629e5216c05c35a7485071b6
+  data.tar.gz: c30a273a89fa59c417e3974056916f135083ad50320dbb18c063b3db0c365231bb09118611770e1a158435997733101e9a917026245936ece186c73a7e9fcf71

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,15 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 3.0
+  Exclude:
+    - '.git/**/*'
+    - 'Rakefile'
+    - 'examples/**/*'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3.0

data/.vscode/launch.json

@@ -0,0 +1,32 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+      {
+        "type": "ruby_lsp",
+        "name": "RSpec: Run Current Spec File",
+        "request": "launch",
+        "program": "${workspaceFolder}/bin/rspec ${file}",
+        "env": {
+          "RAILS_ENV": "test"
+        }
+      },
+      {
+        "type": "ruby_lsp",
+        "name": "RSpec: Run All Specs",
+        "request": "launch",
+        "program": "${workspaceFolder}/bin/rspec",
+        "env": {
+          "RAILS_ENV": "test"
+        }
+      },
+      {
+        "type": "ruby_lsp",
+        "name": "RSpec: Run Test at Cursor",
+        "request": "launch",
+        "program": "${workspaceFolder}/bin/rspec ${file}:${lineNumber}",
+        "env": {
+          "RAILS_ENV": "test"
+        }
+      }
+    ]
+  }

data/.vscode/settings.json

@@ -0,0 +1,33 @@
+{
+  "[ruby]": {
+    "editor.defaultFormatter": "Shopify.ruby-lsp",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+    "editor.insertSpaces": true,
+    "editor.semanticHighlighting.enabled": true,
+    "editor.formatOnType": true
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2
+  },
+  "rubyLsp.enabledFeatures": {
+    "codeActions": true,
+    "diagnostics": true,
+    "documentHighlights": true,
+    "documentLink": true,
+    "documentSymbols": true,
+    "foldingRanges": true,
+    "formatting": true,
+    "hover": true,
+    "inlayHint": true,
+    "onTypeFormatting": true,
+    "selectionRanges": true,
+    "semanticHighlighting": true,
+    "completion": true,
+    "codeLens": true
+  },
+  "rubyLsp.formatter": "rubocop",
+  "ruby.rubocop.configFilePath": ".rubocop.yml"
+}

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,167 @@
+# TraceViz
+
+[![Gem Version](https://badge.fury.io/rb/trace_viz.svg)](https://rubygems.org/gems/trace_viz)
+[![Downloads](https://img.shields.io/gem/dt/trace_viz)](https://rubygems.org/gems/trace_viz)
+[![Build Status](https://github.com/patrick204nqh/trace_viz/actions/workflows/main.yml/badge.svg)](https://github.com/patrick204nqh/trace_viz/actions)
+[![Maintainability](https://api.codeclimate.com/v1/badges/e97579abe66f3477e71d/maintainability)](https://codeclimate.com/github/patrick204nqh/trace_viz/maintainability)
+![License](https://img.shields.io/github/license/patrick204nqh/trace_viz)
+
+TraceViz is a Ruby library designed to trace and visualize events executed in a block of code. It is useful for logging, debugging, and generating diagrams to understand code execution and flow. The gem allows you to customize how much detail you want to see, such as method calls, parameters, return values, and execution times.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```bash
+gem 'trace_viz'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install trace_viz
+```
+
+## Usage
+
+Wrap your code inside the TraceViz.trace block to start tracing its execution. The tracing behavior can be customized using various options:
+
+```ruby
+TraceViz.trace(
+  tab_size: 2,
+  show_indent: true,
+  show_depth: true,
+  max_display_depth: 4, # Recommended to keep this value between 3 and 5
+  show_method_name: true,
+  show_source_location: false,
+  show_params: true,
+  show_return_value: true,
+  show_execution_time: true,
+  show_trace_events: [:call, :return]
+) do
+  # Your code here
+end
+```
+
+**Example**
+
+```ruby
+class Example
+  def perform_task(x, y)
+    result = add_numbers(x, y)
+    log_result(result)
+    result
+  end
+
+  def add_numbers(a, b)
+    sleep(0.1)
+    sum = a + b
+    multiply_by_factor(sum, 2)
+  end
+
+  def multiply_by_factor(value, factor)
+    sleep(0.05)
+    value * factor
+  end
+
+  def log_result(result)
+    sleep(0.02)
+    puts "Final result: #{result}"
+  end
+end
+
+TraceViz.trace(
+    tab_size: 4,
+    show_indent: true,
+    show_depth: true,
+    max_display_depth: 3,
+    show_method_name: true,
+    show_source_location: false,
+    show_params: true,
+    show_return_value: true,
+    show_execution_time: true,
+    show_trace_events: [:call, :return]
+) do
+  example = Example.new
+  example.perform_task(5, 7)
+end
+```
+
+**Output**
+
+```bash
+🚀   [START]   #depth:0 Example#perform_task (5, 7, nil)
+🚀   [START]       #depth:1 Example#add_numbers (5, 7, nil)
+🚀   [START]           #depth:2 Example#multiply_by_factor (12, 2)
+🏁   [FINISH]          #depth:2 Example#multiply_by_factor #=> 24
+🏁   [FINISH]      #depth:1 Example#add_numbers #=> 24
+🚀   [START]       #depth:1 Example#log_result (24)
+Final result: 24
+🏁   [FINISH]      #depth:1 Example#log_result #=> nil
+🏁   [FINISH]  #depth:0 Example#perform_task #=> 24
+```
+
+### Configuration Options
+
+| Option                 | Type             | Description                                                                      |
+| ---------------------- | ---------------- | -------------------------------------------------------------------------------- |
+| `tab_size`             | Integer          | Defines the number of spaces used for indentation when `show_indent` is enabled. |
+| `show_indent`          | Boolean          | Whether to visually indent nested calls.                                         |
+| `show_depth`           | Boolean          | Displays the depth level of the method call.                                     |
+| `max_display_depth`    | Integer          | Limits the display to a maximum depth of calls.                                  |
+| `show_method_name`     | Boolean          | Shows the name of the method being called.                                       |
+| `show_source_location` | Boolean          | Logs the source file name and line number where the method is defined.           |
+| `show_params`          | Boolean          | Logs the parameters passed to the method.                                        |
+| `show_return_value`    | Boolean          | Logs the return value of the method.                                             |
+| `show_execution_time`  | Boolean          | Logs the execution time for methods.                                             |
+| `show_trace_events`    | Array of Symbols | Specifies the events to trace. Valid values include:                             |
+|                        |                  | - `:call` - Log method calls.                                                    |
+|                        |                  | - `:return` - Log method returns.                                                |
+
+## Development
+
+To set up your development environment:
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/patrick204nqh/trace_viz.git
+```
+
+2. Navigate to the project directory:
+
+```bash
+cd trace_viz
+```
+
+3. Install dependencies:
+
+```bash
+bundle install
+```
+
+4. Run the test suite:
+
+```bash
+bin/rspec
+```
+
+You can use `irb` or `pry` to test the gem locally. Make your changes, add tests, and ensure all tests pass before submitting a pull request.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/patrick204nqh/trace_viz. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/patrick204nqh/trace_viz/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+TraceViz is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Acknowledgements
+
+Special thanks to the Ruby community for their continued support and inspiration!

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/examples/example.rb

@@ -0,0 +1,42 @@
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+require "trace_viz"
+
+class Example
+  def perform_task(x, y)
+    result = add_numbers(x, y)
+    log_result(result)
+    result
+  end
+
+  def add_numbers(a, b)
+    sleep(0.1)
+    sum = a + b
+    multiply_by_factor(sum, 2)
+  end
+
+  def multiply_by_factor(value, factor)
+    sleep(0.05)
+    value * factor
+  end
+
+  def log_result(result)
+    sleep(0.02)
+    puts "Final result: #{result}"
+  end
+end
+
+TraceViz.trace(
+    tab_size: 4,
+    show_indent: true,
+    show_depth: true,
+    max_display_depth: 3,
+    show_method_name: true,
+    show_params: true,
+    show_return_value: true,
+    show_execution_time: true,
+    show_source_location: true,
+    show_trace_events: [:call, :return]
+) do
+  example = Example.new
+  example.perform_task(5, 7)
+end

data/lib/trace_viz/adapters/base_adapter.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "trace_viz/context"
+
+module TraceViz
+  module Adapters
+    class BaseAdapter
+      def trace
+        raise NotImplementedError
+      end
+    end
+  end
+end

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

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

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

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