trace_viz 0.0.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33ae44f03b5cb5a5e546e27adf7d71e4100adb014659122b51ead6c185203b48
-  data.tar.gz: 712c78b3b7cd93f7512fa7f25a1bcf0a3424b45819ec52ae80c4a9b480385282
+  metadata.gz: bb4571e8a37548c6819b56d576ec740c9052efe64c2984cd65a6a06f53e935b3
+  data.tar.gz: 7dfd025e87f5076957783b45512a6c8aca8b65dd98ec67bd6318681efd5d1d3c
 SHA512:
-  metadata.gz: 178cd46ddd00503c6a7783d8697d7d90dfccb15980e3af6b0f8cdb39999809f4e5f0d541bb9809414149c1c0984ebaff485aa634b42b47aee2f2b1615b2d9cef
-  data.tar.gz: d61a9e82387c176eb31e06651c894ff3113924bcee1eaef10d23d47355f3eca3363165a6d63cb222c57aa0db908f4557c56e24c295496088c1213113fae14857
+  metadata.gz: 2bf8264a62463c20f1e585fac19835f8d739fe703c4dfaef159e8c3fde331ace651f750c17591da5c3441faf6cf33d9baff2af6048c457bdc89d3a5e76148015
+  data.tar.gz: 4ae53f49154cbb6b6c0a95075c62ccd698ad3154abb3a5871a2697019020a99634fa9a82ddee118d81ec29543de2ad5cd7610a6f57c6429d7700372581f2f91a

data/README.md

@@ -2,19 +2,18 @@
 
 [![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)
+[![Build Status](https://github.com/patrick204nqh/trace_viz/actions/workflows/ci.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)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/e97579abe66f3477e71d/test_coverage)](https://codeclimate.com/github/patrick204nqh/trace_viz/test_coverage)
 ![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.
 
-> **Note:** The diagram generation feature is currently under development.
-
 The gem allows you to customize how much detail you want to see, such as method calls, parameters, return values, and execution times.
 
 ## Demo
 
-[![asciicast](https://asciinema.org/a/pKjqLFNPxQFQWucTzcGMpt6QE.svg)](https://asciinema.org/a/pKjqLFNPxQFQWucTzcGMpt6QE)
+[![asciicast](https://asciinema.org/a/lKXPPgx0muZuQbtvMu8GyHaOV.svg)](https://asciinema.org/a/lKXPPgx0muZuQbtvMu8GyHaOV)
 
 ## Installation
 
@@ -142,12 +141,14 @@ TraceViz.trace(
   },
   filters: [
     :exclude_internal_call,
-    include_classes: [Example]
+    include_classes: {
+      classes: [Example]
+    }
   ],
   export: {
     enabled: true,
     path: "tmp",
-    format: :txt,
+    format: :txt, # Select :mermaid to export a mermaid diagram
     overwrite: false,
   }
 ) do
@@ -158,9 +159,7 @@ end
 
 </details>
 
-**Output**
-
-<details>
+<details open>
   <summary>Sample Output</summary>
 
 ```bash
@@ -177,48 +176,74 @@ Final result: 24
 
 </details>
 
+<details open>
+<summary>Sample Diagram</summary>
+
+```mermaid
+sequenceDiagram
+    box rgb(224, 236, 221) Example
+    participant E as Example
+    end
+    E ->> E: perform_task(x: 5, y: 7)
+    Note over E: 24
+    activate E
+    E ->> E: add_numbers(a: 5, b: 7)
+    Note over E: 24
+    activate E
+    E ->> E: multiply_by_factor(value: 12, factor: 2)
+    Note over E: 24
+    deactivate E
+    E ->> E: log_result(result: 24)
+    Note over E: nil
+    deactivate E
+```
+
+</details>
+
 ### Configuration Options
 
 TraceViz provides extensive configuration options to customize tracing behavior.
 
-| Group             | Option                     | Type             | Default Value      | Description                                                       |
-| ----------------- | -------------------------- | ---------------- | ------------------ | ----------------------------------------------------------------- |
-| `general`         | `tab_size`                 | Integer          | 2                  | Number of spaces for indentation.                                 |
-|                   | `show_indent`              | Boolean          | true               | Enables visual indentation for nested calls.                      |
-|                   | `show_depth`               | Boolean          | true               | Displays the depth level of the method call.                      |
-|                   | `max_display_depth`        | Integer          | 3                  | Maximum depth of calls to display.                                |
-|                   | `show_method_name`         | Boolean          | true               | Logs the name of the method being executed.                       |
-| `source_location` | `show`                     | Boolean          | false              | Logs the source file and line number for methods.                 |
-|                   | `truncate_length`          | Integer          | 100                | Maximum length of displayed source location information.          |
-| `params`          | `show`                     | Boolean          | true               | Logs method parameters.                                           |
-|                   | `mode`                     | Symbol           | `:name_and_value`  | Parameter display mode (`:name`, `:value`, or `:name_and_value`). |
-|                   | `truncate_values`          | Integer          | 50                 | Maximum length of parameter values to display.                    |
-| `result`          | `show`                     | Boolean          | true               | Logs method return values.                                        |
-|                   | `truncate_length`          | Integer          | 50                 | Maximum length of return value logs.                              |
-| `execution`       | `show_time`                | Boolean          | true               | Logs execution time for methods.                                  |
-|                   | `show_trace_events`        | Array of Symbols | `[:call, :return]` | Specifies the trace events to log (e.g., `:call`, `:return`).     |
-| `filters`         | `:exclude_internal_call`   | Symbol           | N/A                | Exclude internal Ruby calls.                                      |
-|                   | `:exclude_default_classes` | Symbol           | N/A                | Skip logging standard library classes.                            |
-|                   | `:exclude_rails_framework` | Symbol           | N/A                | Ignore Rails framework classes and methods.                       |
-|                   | `include_classes`          | Hash             | N/A                | Specify classes to include in tracing.                            |
-|                   | - `classes`                | Array            | []                 | List of class names to include (e.g., `["ClassName"]`).           |
-|                   | `exclude_classes`          | Hash             | N/A                | Specify classes to exclude from tracing.                          |
-|                   | - `classes`                | Array            | []                 | List of class names to exclude (e.g., `["ClassName"]`).           |
-|                   | `include_gems`             | Hash             | N/A                | Include specific gems or runtime application gems.                |
-|                   | - `app_running`            | Boolean          | true               | Include the code of the application.                              |
-|                   | - `app_path`               | String           | `Dir.pwd`          | Path to the application (e.g., `Dir.pwd`).                        |
-|                   | - `gems`                   | Array            | []                 | List of gems to include (e.g., `["gem1", "gem2"]`).               |
-|                   | `exclude_gems`             | Hash             | N/A                | Exclude specified gems.                                           |
-|                   | - `gems`                   | Array            | []                 | List of gems to exclude (e.g., `["excluded_gem"]`).               |
-| `export`          | `enabled`                  | Boolean          | true               | Enables or disables exporting of trace logs.                      |
-|                   | `path`                     | String           | `"tmp"`            | Directory for exported trace logs.                                |
-|                   | `format`                   | Symbol           | `:txt`             | Format for trace logs (`:txt` or other supported formats).        |
-|                   | `overwrite`                | Boolean          | false              | Prevents overwriting of existing exported files.                  |
+| Group             | Option                     | Type             | Default Value               | Description                                                                      |
+| ----------------- | -------------------------- | ---------------- | --------------------------- | -------------------------------------------------------------------------------- |
+| `general`         | `tab_size`                 | Integer          | 2                           | Number of spaces for indentation.                                                |
+|                   | `mode`                     | Symbol           | `:summary`                  | Display mode (`:summary` or `:verbose`).                                         |
+|                   | `group_keys`               | Array of Symbols | `[:event, :klass, :action]` | Keys to group similar outputs.                                                   |
+|                   | `show_indent`              | Boolean          | true                        | Enables visual indentation for nested calls.                                     |
+|                   | `show_depth`               | Boolean          | true                        | Displays the depth level of the method call.                                     |
+|                   | `max_display_depth`        | Integer          | 3                           | Maximum depth of calls to display.                                               |
+|                   | `show_method_name`         | Boolean          | true                        | Logs the name of the method being executed.                                      |
+| `source_location` | `show`                     | Boolean          | false                       | Logs the source file and line number for methods.                                |
+|                   | `truncate_length`          | Integer          | 100                         | Maximum length of displayed source location information.                         |
+| `params`          | `show`                     | Boolean          | true                        | Logs method parameters.                                                          |
+|                   | `mode`                     | Symbol           | `:name_and_value`           | Parameter display mode (`:name`, `:value`, or `:name_and_value`).                |
+|                   | `truncate_values`          | Integer          | 50                          | Maximum length of parameter values to display.                                   |
+| `result`          | `show`                     | Boolean          | true                        | Logs method return values.                                                       |
+|                   | `truncate_length`          | Integer          | 50                          | Maximum length of return value logs.                                             |
+| `execution`       | `show_time`                | Boolean          | true                        | Logs execution time for methods.                                                 |
+|                   | `show_trace_events`        | Array of Symbols | `[:call, :return]`          | Specifies the trace events to log (e.g., `:call`, `:return`).                    |
+| `filters`         | `:exclude_internal_call`   | Symbol           | N/A                         | Exclude internal Ruby calls.                                                     |
+|                   | `:exclude_default_classes` | Symbol           | N/A                         | Skip logging standard library classes.                                           |
+|                   | `:exclude_rails_framework` | Symbol           | N/A                         | Ignore Rails framework classes and methods.                                      |
+|                   | `include_classes`          | Hash             | N/A                         | Specify classes to include in tracing.                                           |
+|                   | - `classes`                | Array            | []                          | List of class names to include (e.g., `["ClassName"]`).                          |
+|                   | `exclude_classes`          | Hash             | N/A                         | Specify classes to exclude from tracing.                                         |
+|                   | - `classes`                | Array            | []                          | List of class names to exclude (e.g., `["ClassName"]`).                          |
+|                   | `include_gems`             | Hash             | N/A                         | Include specific gems or runtime application gems.                               |
+|                   | - `app_running`            | Boolean          | true                        | Include the code of the application.                                             |
+|                   | - `app_path`               | String           | `Dir.pwd`                   | Path to the application (e.g., `Dir.pwd`).                                       |
+|                   | - `gems`                   | Array            | []                          | List of gems to include (e.g., `["gem1", "gem2"]`).                              |
+|                   | `exclude_gems`             | Hash             | N/A                         | Exclude specified gems.                                                          |
+|                   | - `gems`                   | Array            | []                          | List of gems to exclude (e.g., `["excluded_gem"]`).                              |
+| `export`          | `enabled`                  | Boolean          | true                        | Enables or disables exporting of trace logs.                                     |
+|                   | `path`                     | String           | `"tmp"`                     | Directory for exported trace logs.                                               |
+|                   | `format`                   | Symbol           | `:txt`                      | Format for trace logs. Use :txt for plain text or :mermaid for mermaid diagrams. |
+|                   | `overwrite`                | Boolean          | false                       | Prevents overwriting of existing exported files.                                 |
 
 ### Notes
 
 - **Default Skipped Classes**: The following standard library classes are excluded by default when `:exclude_default_classes` is enabled:
-  - `Object`, `String`, `Array`, `Hash`, `Numeric`, `Integer`, `Float`, `Symbol`, `Kernel`, `Module`, `Class`, `Range`, `Regexp`.
+  - `Object`, `String`, `Array`, `Hash`, `Numeric`, `Integer`, `Float`, `Symbol`, `Kernel`, `Module`, `Class`, `Range`, `Regexp`, `Set`, `Gem`.
 
 ## Development
 

data/Steepfile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+  # ignore_signature "sig/test"
+
+  check "lib" # Directory name
+  # check "path/to/source.rb"         # File name
+  # check "app/models/**/*.rb"        # Glob
+  # ignore "lib/templates/*.rb"
+
+  # library "pathname"              # Standard libraries
+  # library "strong_json"           # Gems
+
+  # configure_code_diagnostics(D::Ruby.default)      # `default` diagnostics setting (applies by default)
+  # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.silent)       # `silent` diagnostics setting
+  # configure_code_diagnostics do |hash|             # You can setup everything yourself
+  #   hash[D::Ruby::NoMethod] = :information
+  # end
+end
+
+target :test do
+  unreferenced! # Skip type checking the `lib` code when types in `test` target is changed
+  # signature "sig/test"              # Put RBS files for tests under `sig/test`
+  check "test" # Type check Ruby scripts under `test`
+
+  configure_code_diagnostics(D::Ruby.lenient) # Weak type checking for test code
+
+  # library "pathname"              # Standard libraries
+end

data/examples/eu_central_bank.rb

@@ -0,0 +1,69 @@
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+require 'eu_central_bank'
+require 'i18n'
+require 'trace_viz'
+
+# Fix the locale issue
+I18n.config.available_locales = [:en]
+I18n.locale = :en
+
+TraceViz.trace(
+  general: {
+    tab_size: 1,
+    mode: :summary,
+    show_indent: true,
+    show_depth: true,
+    max_display_depth: 5,
+    show_method_name: true,
+  },
+  params: {
+    show: true,
+    mode: :name_only,
+    # truncate_length: 10
+  },
+  result: {
+    show: true,
+    truncate_length: 15,
+  },
+  source_location: {
+    show: true,
+    truncate_length: 50,
+  },
+  execution: {
+    show_time: true,
+    show_trace_events: [:call, :return],
+  },
+  log: {
+    runtime: false,
+    post_collection: true,
+    stats: true
+  },
+  filters: [
+    :exclude_internal_call,
+    :exclude_default_classes,
+    # include_classes: {
+    #   classes: [EuCentralBank],
+    # },
+    # exclude_classes: {
+    #   classes: ['Gem']
+    # },
+    exclude_gems: {
+      gems: ['nokogiri', 'money', 'i18n']
+    }
+  ],
+  export: {
+    enabled: true,
+    format: :txt,
+    overwrite: true,
+  }
+) do
+  # Create a new instance of the EuCentralBank
+  bank = EuCentralBank.new
+
+  # Trace the update of exchange rates
+  bank.update_rates
+
+  # Trace conversion of currency
+  result = bank.exchange(50, 'USD', 'EUR')
+  puts "Converted amount: #{result}"
+end