rails_tracepoint_stack 0.3.4 → 0.4.0

data/lib/rails_tracepoint_stack/truncator.rb

@@ -0,0 +1,50 @@
+module RailsTracepointStack
+  # Shrinks an already-serialized value so one fat argument (a big payload, a
+  # long SQL string, a loaded association) cannot dominate the output. Runs
+  # over the plain structures LogFormatter.safe_value produces, so it only
+  # ever sees strings, numbers, booleans, nil, arrays and hashes.
+  module Truncator
+    ELLIPSIS = "…".freeze
+
+    def self.call(value, limits)
+      case value
+      when String then truncate_string(value, limits)
+      when Array then truncate_array(value, limits)
+      when Hash then truncate_hash(value, limits)
+      else value
+      end
+    end
+
+    def self.truncate_string(value, limits)
+      max = limits.max_string_length
+      return value if max.nil? || value.length <= max
+
+      "#{value[0, max]}#{ELLIPSIS} (#{value.length} chars)"
+    end
+
+    def self.truncate_array(value, limits)
+      max = limits.max_collection_size
+      kept = (max.nil? || value.length <= max) ? value : value.first(max)
+      result = kept.map { |item| call(item, limits) }
+
+      return result if kept.length == value.length
+
+      result << "(+#{value.length - kept.length} more)"
+    end
+
+    def self.truncate_hash(value, limits)
+      max = limits.max_collection_size
+      dropped = (max.nil? || value.size <= max) ? 0 : value.size - max
+      kept = dropped.zero? ? value : value.first(max).to_h
+
+      result = kept.each_with_object({}) do |(key, item), memo|
+        memo[key] = call(item, limits)
+      end
+
+      return result if dropped.zero?
+
+      result[ELLIPSIS] = "(+#{dropped} more)"
+      result
+    end
+  end
+end

data/lib/rails_tracepoint_stack/version.rb

@@ -1,3 +1,3 @@
 module RailsTracepointStack
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 end

data/lib/rails_tracepoint_stack.rb

@@ -1,6 +1,10 @@
 require 'rails_tracepoint_stack/configuration'
 require 'rails_tracepoint_stack/log_formatter'
 require 'rails_tracepoint_stack/tracer'
+require 'rails_tracepoint_stack/limits'
+require 'rails_tracepoint_stack/skill_installer'
+require 'rails_tracepoint_stack/sink/collector'
+require 'rails_tracepoint_stack/trace_session'
 
 $rails_tracer_rtps = nil
 
@@ -17,10 +21,41 @@ module RailsTracepointStack
     yield(configuration)
   end
 
+  CAPTURE_EVENTS = [:call, :return, :raise].freeze
+
+  # Traces a block and hands back everything that happened inside it, instead
+  # of writing to a log. Meant to be run as a one-off: capture, read, done.
+  def self.capture(threads: :current, **limit_options)
+    raise ArgumentError, "Block not given to #capture" unless block_given?
+
+    collector = RailsTracepointStack::Sink::Collector.new(
+      limits: RailsTracepointStack::Limits.new(**limit_options)
+    )
+    session = collector.session
+    tracer = RailsTracepointStack::Tracer.new(
+      sink: collector,
+      events: CAPTURE_EVENTS,
+      thread: (threads == :all) ? nil : Thread.current
+    )
+
+    tracer.enable
+    begin
+      session.result = yield(session)
+    rescue Exception => error
+      session.error = error
+      raise
+    ensure
+      tracer.disable
+      session.filtered_count = tracer.filtered_count
+    end
+
+    session
+  end
+
   def self.enable_trace
     raise ArgumentError, "Block not given to #enable_trace" unless block_given?
 
-    tracer = RailsTracepointStack::Tracer.new.tracer
+    tracer = RailsTracepointStack::Tracer.new
     tracer.enable
     yield
   ensure
@@ -28,8 +63,8 @@ module RailsTracepointStack
   end
 end
 
-if ENV.fetch('RAILS_TRACEPOINT_STACK_ENABLED', 'false') == 'true'
-  $rails_tracer_rtps = RailsTracepointStack::Tracer.new.tracer
+if ENV.fetch("RAILS_TRACEPOINT_STACK_ENABLED", "false") == "true"
+  $rails_tracer_rtps = RailsTracepointStack::Tracer.new
   $rails_tracer_rtps.enable
 
   at_exit do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_tracepoint_stack
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Carlos Daniel Pohlod
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-03 00:00:00.000000000 Z
+date: 2026-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -50,35 +50,72 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 13.0.0
-description: A formatted output of all methods called in your rails application of
-  code created by the developer, with the complete path to the class/module, including
-  passed params.
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.39.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.39.1
+description: Traces a block of your Rails app and returns the call tree of your own
+  code - arguments, return values, raised exceptions and call depth - with gems, the
+  framework and stdlib filtered out. Bounded output meant to be read directly, by
+  a developer or by an AI coding agent debugging the app.
 email: carlospohlod@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- changelog.md
+- lib/generators/rails_tracepoint_stack/install/install_generator.rb
 - lib/rails_tracepoint_stack.rb
 - lib/rails_tracepoint_stack/configuration.rb
+- lib/rails_tracepoint_stack/depth_tracker.rb
 - lib/rails_tracepoint_stack/filter/custom_trace_selector_filter.rb
 - lib/rails_tracepoint_stack/filter/gem_path.rb
 - lib/rails_tracepoint_stack/filter/rb_config.rb
 - lib/rails_tracepoint_stack/filter/trace_from_dependencies_filter.rb
 - lib/rails_tracepoint_stack/filter/trace_from_ruby_code_filter.rb
 - lib/rails_tracepoint_stack/filter/trace_to_ignore_filter.rb
+- lib/rails_tracepoint_stack/limits.rb
 - lib/rails_tracepoint_stack/log_formatter.rb
 - lib/rails_tracepoint_stack/logger.rb
+- lib/rails_tracepoint_stack/renderer/summary.rb
+- lib/rails_tracepoint_stack/renderer/tree.rb
+- lib/rails_tracepoint_stack/sink/collector.rb
+- lib/rails_tracepoint_stack/sink/log.rb
+- lib/rails_tracepoint_stack/skill_installer.rb
+- lib/rails_tracepoint_stack/templates/skill.md
 - lib/rails_tracepoint_stack/trace.rb
 - lib/rails_tracepoint_stack/trace_filter.rb
+- lib/rails_tracepoint_stack/trace_record.rb
+- lib/rails_tracepoint_stack/trace_session.rb
 - lib/rails_tracepoint_stack/tracer.rb
+- lib/rails_tracepoint_stack/truncator.rb
 - lib/rails_tracepoint_stack/version.rb
-homepage: https://github.com/carlosdanielpohlod/rails_tracepoint_stack/
+homepage: https://carlosdanielpohlod.github.io/rails_tracepoint_stack/
 licenses:
 - MIT
 metadata:
-  documentation_uri: https://github.com/carlosdanielpohlod/rails_tracepoint_stack/
+  source_code_uri: https://github.com/carlosdanielpohlod/rails_tracepoint_stack
+  documentation_uri: https://github.com/carlosdanielpohlod/rails_tracepoint_stack#readme
+  bug_tracker_uri: https://github.com/carlosdanielpohlod/rails_tracepoint_stack/issues
   changelog_uri: https://github.com/carlosdanielpohlod/rails_tracepoint_stack/blob/main/changelog.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,8 +130,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
-summary: Get a complete stack trace for your code on a Rails application.
+summary: 'Runtime call tree for a Rails app: which methods ran, with what params,
+  and what they returned.'
 test_files: []