rails_tracepoint_stack 0.3.3 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37171281cd058faf3a6dadf86d4a2e56e57417f1ccf46af6d010a2a1f5657562
-  data.tar.gz: 7bc1956035baaf3308ed562024c7376eb59a6c6bb59e23e450a66f51e2b2d650
+  metadata.gz: f67c982828a7ad060513cbb50daf9f88399229a534a43cf12a674571b6ae11ae
+  data.tar.gz: fd80c178bf9de58408e769742d7640b0ccdbcc99a4722ec9ccbd6e68d115ff51
 SHA512:
-  metadata.gz: 0f452899bde414b1a11dce5fd483843b980629c1dad42aa73b045c9c3315dd9226b36cd98f47b8a5c11221aed26d2aaf62c87fd294a07145936a100c164f3a07
-  data.tar.gz: 37fb83da7315e329a9d75ad32ca198c7464be7aadead056abd19f0a1ad3190e859c0d4c4bb47572a0755cb259349b45bd3984ec50ef74ece89a843aa4f2d5c52
+  metadata.gz: 57b7125a7a242bf59f15096fffeef7de3c8a7543162fa7851566a07256d2ed790d39ff9c9dfcd1f3c3f8ca54714b797ed5f5015f2eb0d6f0adbe57e3ad582412
+  data.tar.gz: cd33cf3e53fe35fe62ba3867cfe8ff56047cceae59e2139c55898fcb0ed0e44d8dccf57a0b66954f1543797c1cb1070b6c68f479f76ce80f0c15282518c50110

data/lib/rails_tracepoint_stack/filter/custom_trace_selector_filter.rb

@@ -0,0 +1,19 @@
+module RailsTracepointStack
+  module Filter
+    module CustomTraceSelectorFilter
+      def is_a_trace_required_to_watch_by_the_custom_configs?(trace:)
+        return false unless RailsTracepointStack.configuration.file_path_to_filter_patterns.any?
+
+        filter_match_a_custom_pattern_to_be_not_ignored?(trace)
+      end
+
+      private
+
+      def filter_match_a_custom_pattern_to_be_not_ignored?(trace)
+        RailsTracepointStack.configuration.file_path_to_filter_patterns.any? do |pattern|
+          trace.file_path.match?(pattern)
+        end
+      end
+    end
+  end
+end

data/lib/rails_tracepoint_stack/filter/rb_config.rb

@@ -2,7 +2,7 @@ module RailsTracepointStack
   module Filter
     class RbConfig
       def self.ruby_lib_path
-        @ruby_lib_path ||= ::RbConfig::CONFIG['rubylibdir']
+        @ruby_lib_path ||= ::RbConfig::CONFIG["rubylibdir"]
       end
     end
   end

data/lib/rails_tracepoint_stack/filter/trace_from_dependencies_filter.rb

@@ -0,0 +1,42 @@
+require 'rails_tracepoint_stack/filter/gem_path'
+require 'rails_tracepoint_stack/filter/rb_config'
+
+module RailsTracepointStack
+  module Filter
+    module TraceFromDependenciesFilter
+      def should_ignore_because_is_a_internal_dependency?(trace:)
+        return false if not_ignore_external_source_traces?
+        
+        file_path_starts_with_gem_path?(trace) ||
+        file_path_starts_with_ruby_lib_path?(trace) ||
+        file_path_include_bundler_gems_path?(trace)
+      end
+
+      private
+
+      def file_path_starts_with_gem_path?(trace)
+        gem_paths.any? { |path| trace.file_path.start_with?(path) }
+      end
+   
+      def file_path_starts_with_ruby_lib_path?(trace)
+        trace.file_path.start_with?(ruby_lib_path)
+      end
+  
+      def file_path_include_bundler_gems_path?(trace)
+        trace.file_path.include?("gems/bundler")
+      end
+  
+      def gem_paths
+        @gem_paths ||= RailsTracepointStack::Filter::GemPath.full_gem_path
+      end
+  
+      def ruby_lib_path
+        @ruby_lib_path ||= RailsTracepointStack::Filter::RbConfig.ruby_lib_path
+      end
+
+      def not_ignore_external_source_traces?
+        RailsTracepointStack.configuration.log_external_sources
+      end
+    end
+  end
+end

data/lib/rails_tracepoint_stack/filter/trace_from_ruby_code_filter.rb

@@ -0,0 +1,17 @@
+module RailsTracepointStack
+  module Filter
+    module TraceFromRubyCodeFilter
+      def should_ignore_because_is_ruby_trace?(trace:)
+        return false if not_ignore_external_source_traces?
+
+        trace.file_path.start_with?('<internal:') || trace.file_path == '(eval)'
+      end 
+
+      private
+
+      def not_ignore_external_source_traces?
+        RailsTracepointStack.configuration.log_external_sources
+      end
+    end
+  end
+end

data/lib/rails_tracepoint_stack/filter/trace_to_ignore_filter.rb

@@ -0,0 +1,14 @@
+module RailsTracepointStack
+  module Filter
+    module TraceToIgnoreFilter
+      def attends_some_custom_pattern_to_ignore?(trace:)
+        return false unless RailsTracepointStack.configuration.ignore_patterns.any?
+        
+        RailsTracepointStack
+          .configuration
+          .ignore_patterns
+          .any? { |pattern| trace.file_path.match?(pattern) }
+      end
+    end
+  end
+end

data/lib/rails_tracepoint_stack/log_formatter.rb

@@ -1,3 +1,5 @@
+require "json"
+
 module RailsTracepointStack
   module LogFormatter
     def self.message(trace)
@@ -10,17 +12,183 @@ module RailsTracepointStack
     end
 
     def self.text(trace)
-      "called: #{trace.class_name}##{trace.method_name} in #{trace.file_path}:#{trace.line_number} with params: #{trace.params}"
+      "called: #{trace.class_name}##{trace.method_name} in #{trace.file_path}:#{trace.line_number} with params: #{text_value(trace.params)}"
     end
 
     def self.json(trace)
-      {
-        class: trace.class_name,
-        method_name: trace.method_name,
-        path: trace.file_path,
+      JSON.generate(
+        class: stringify(trace.class_name),
+        method_name: stringify(trace.method_name),
+        path: stringify(trace.file_path),
         line: trace.line_number,
-        params: trace.params
-      }.to_json
+        params: safe_value(trace.params)
+      )
+    end
+
+    def self.stringify(value)
+      return nil if value.nil?
+
+      value.to_s
+    rescue SystemStackError, StandardError => error
+      inspect_fallback(value, error)
+    end
+
+    def self.safe_value(value, ancestry = {})
+      case value
+      when nil, true, false, Numeric, String
+        value
+      when Symbol
+        value.to_s
+      when Array
+        safe_array(value, ancestry)
+      when Hash
+        safe_hash(value, ancestry)
+      else
+        safe_json_object(value)
+      end
+    rescue SystemStackError, StandardError => error
+      inspect_fallback(value, error)
+    end
+
+    def self.safe_array(value, ancestry)
+      object_id = value.__id__
+      return recursive_placeholder(value) if ancestry.key?(object_id)
+
+      ancestry[object_id] = true
+      value.map { |item| safe_value(item, ancestry) }
+    ensure
+      ancestry.delete(object_id)
+    end
+
+    def self.safe_hash(value, ancestry)
+      object_id = value.__id__
+      return recursive_placeholder(value) if ancestry.key?(object_id)
+
+      ancestry[object_id] = true
+      value.each_with_object({}) do |(key, item), result|
+        result[safe_hash_key(key, ancestry)] = safe_value(item, ancestry)
+      end
+    ensure
+      ancestry.delete(object_id)
+    end
+
+    def self.safe_hash_key(key, ancestry = {})
+      case key
+      when String
+        key
+      when Symbol, Numeric
+        key.to_s
+      when true, false, nil
+        key.inspect
+      else
+        stringify_hash_key(key, ancestry)
+      end
+    end
+
+    def self.safe_json_object(value)
+      json_value = JSON.parse(JSON.generate(value))
+
+      return json_value unless default_string_representation?(value, json_value)
+
+      safe_object_string(value)
+    rescue SystemStackError, StandardError
+      safe_object_string(value)
+    end
+
+    def self.default_string_representation?(value, json_value)
+      json_value.is_a?(String) &&
+        value.method(:to_s).owner == Kernel &&
+        json_value == value.to_s
+    rescue SystemStackError, StandardError
+      false
+    end
+
+    def self.stringify_hash_key(key, ancestry)
+      normalized_key = safe_value(key, ancestry)
+
+      case normalized_key
+      when String
+        normalized_key
+      when nil
+        "null"
+      when true, false, Numeric
+        normalized_key.to_s
+      else
+        JSON.generate(normalized_key)
+      end
+    rescue SystemStackError, StandardError
+      safe_object_string(key)
+    end
+
+    def self.safe_object_string(value)
+      value.inspect
+    rescue SystemStackError, StandardError => error
+      inspect_fallback(value, error)
+    end
+
+    def self.inspect_fallback(value, error)
+      class_name = value.nil? ? "NilClass" : value.class.to_s
+      "#<#{class_name} unserializable: #{error.class}: #{error.message}>"
+    end
+
+    def self.recursive_placeholder(value)
+      "[recursive #{value.class}]"
+    end
+
+    def self.text_value(value, ancestry = {})
+      case value
+      when nil
+        "nil"
+      when true, false, Numeric
+        value.to_s
+      when String
+        value.inspect
+      when Symbol
+        ":#{value}"
+      when Array
+        text_array(value, ancestry)
+      when Hash
+        text_hash(value, ancestry)
+      else
+        safe_object_string(value)
+      end
+    rescue SystemStackError, StandardError => error
+      inspect_fallback(value, error)
+    end
+
+    def self.text_array(value, ancestry)
+      object_id = value.__id__
+      return recursive_placeholder(value) if ancestry.key?(object_id)
+
+      ancestry[object_id] = true
+      "[#{value.map { |item| text_value(item, ancestry) }.join(", ")}]"
+    ensure
+      ancestry.delete(object_id)
+    end
+
+    def self.text_hash(value, ancestry)
+      object_id = value.__id__
+      return recursive_placeholder(value) if ancestry.key?(object_id)
+
+      ancestry[object_id] = true
+      pairs = value.map do |key, item|
+        "#{text_hash_key(key, ancestry)}=>#{text_value(item, ancestry)}"
+      end
+
+      "{#{pairs.join(", ")}}"
+    ensure
+      ancestry.delete(object_id)
+    end
+
+    def self.text_hash_key(key, ancestry = {})
+      case key
+      when Symbol
+        ":#{key}"
+      when String
+        key.inspect
+      else
+        text_value(key, ancestry)
+      end
     end
   end
 end

data/lib/rails_tracepoint_stack/logger.rb

@@ -5,7 +5,7 @@ module RailsTracepointStack
         RailsTracepointStack.configuration.logger.info(msg)
       else
         # TODO: Add the support to Rails.env for the default filename
-        File.open("log/rails_tracepoint_stack.log", 'a') do |f|
+        File.open("log/rails_tracepoint_stack.log", "a") do |f|
           f.puts msg
         end
       end

data/lib/rails_tracepoint_stack/trace.rb

@@ -1,4 +1,4 @@
-require 'forwardable'
+require "forwardable"
 
 module RailsTracepointStack
   class Trace

data/lib/rails_tracepoint_stack/trace_filter.rb

@@ -1,63 +1,30 @@
-require 'rails_tracepoint_stack/filter/gem_path'
-require 'rails_tracepoint_stack/filter/rb_config'
+require 'rails_tracepoint_stack/filter/custom_trace_selector_filter'
+require 'rails_tracepoint_stack/filter/trace_from_dependencies_filter'
+require 'rails_tracepoint_stack/filter/trace_from_ruby_code_filter'
+require 'rails_tracepoint_stack/filter/trace_to_ignore_filter'
 
 module RailsTracepointStack
-  class TraceFilter
-    def self.ignore_trace?(trace:)
-      if defined_file_path_to_filter_patterns?
-        not_matches_file_path_to_filter_patterns?(trace)
-      else
-        contains_to_ignore_strings?(trace) || from_gempath_or_lib_path?(trace) || is_a_to_ignore_pattern?(trace)
+  module TraceFilter
+    include RailsTracepointStack::Filter::CustomTraceSelectorFilter
+    include RailsTracepointStack::Filter::TraceFromDependenciesFilter
+    include RailsTracepointStack::Filter::TraceFromRubyCodeFilter
+    include RailsTracepointStack::Filter::TraceToIgnoreFilter
+
+    def ignore_trace?(trace:)
+      if attends_some_custom_pattern_to_ignore?(trace: trace)
+        return true
       end
-    end
-
-    private
-
-    def self.contains_to_ignore_strings?(trace)
-      trace.file_path.start_with?('<internal:') || trace.file_path == '(eval)'
-    end
-
-    def self.from_gempath_or_lib_path?(trace)
-      !RailsTracepointStack.configuration&.log_external_sources &&
-      (
-        file_path_starts_with_gem_path?(trace) ||
-        file_path_starts_with_ruby_lib_path?(trace) ||
-        file_path_starts_with_bundler_path?(trace)
-      )
-    end
-
-    def self.is_a_to_ignore_pattern?(trace)
-      RailsTracepointStack.configuration&.ignore_patterns&.any? { |pattern| trace.file_path.match?(pattern) }
-    end
-
-    def self.file_path_starts_with_gem_path?(trace)
-     gem_paths.any? { |path| trace.file_path.start_with?(path) }
-    end
-
-    def self.file_path_starts_with_ruby_lib_path?(trace)
-      trace.file_path.start_with?(ruby_lib_path)
-    end
-
-    def self.file_path_starts_with_bundler_path?(trace)
-      trace.file_path.include?("gems/bundler")
-    end
-
-    def self.gem_paths
-      @gem_paths ||= RailsTracepointStack::Filter::GemPath.full_gem_path
-    end
-
-    def self.ruby_lib_path
-      @ruby_lib_path ||= RailsTracepointStack::Filter::RbConfig.ruby_lib_path
-    end
-
-    def self.defined_file_path_to_filter_patterns?
-      RailsTracepointStack.configuration&.file_path_to_filter_patterns&.any?
-    end
-
-    def self.not_matches_file_path_to_filter_patterns?(trace)
-      !RailsTracepointStack.configuration.file_path_to_filter_patterns.any? do |pattern|
-        trace.file_path.match?(pattern)
+      if is_a_trace_required_to_watch_by_the_custom_configs?(trace: trace)
+        return false
       end
+      if should_ignore_because_is_a_internal_dependency?(trace: trace)
+        return true
+      end
+      if should_ignore_because_is_ruby_trace?(trace: trace)
+        return true
+      end
+
+      return false
     end
   end
 end

data/lib/rails_tracepoint_stack/tracer.rb

@@ -1,21 +1,31 @@
-#TODO: Move to a loader file
-require 'rails_tracepoint_stack/logger'
-require 'rails_tracepoint_stack/trace_filter'
-require 'rails_tracepoint_stack/trace'
-require 'rails_tracepoint_stack/log_formatter'
+# TODO: Move to a loader file
+require "rails_tracepoint_stack/logger"
+require "rails_tracepoint_stack/trace_filter"
+require "rails_tracepoint_stack/trace"
+require "rails_tracepoint_stack/log_formatter"
 
 module RailsTracepointStack
   class Tracer
-    # TODO: Tracer.new shoud return the tracer. Is weird to call Tracer.new.tracer
-    def tracer
+    include RailsTracepointStack::TraceFilter
+    extend Forwardable
+ 
+    def_delegators :@tracer, :enable, :disable
+
+    def initialize
+      generate_tracer
+    end
+
+    private
+
+    def generate_tracer
       @tracer ||= TracePoint.new(:call) do |tracepoint|
         trace = RailsTracepointStack::Trace.new(trace_point: tracepoint)
 
-        next if RailsTracepointStack::TraceFilter.ignore_trace?(trace: trace)
+        next if ignore_trace?(trace: trace)
 
         # TODO: Use proper OO
         message = RailsTracepointStack::LogFormatter.message trace
-        RailsTracepointStack::Logger.log message 
+        RailsTracepointStack::Logger.log message
       end
     end
   end

data/lib/rails_tracepoint_stack/version.rb

@@ -1,3 +1,3 @@
 module RailsTracepointStack
-  VERSION = "0.3.3"
+  VERSION = "0.3.5"
 end

data/lib/rails_tracepoint_stack.rb

@@ -1,4 +1,3 @@
-require 'json'
 require 'rails_tracepoint_stack/configuration'
 require 'rails_tracepoint_stack/log_formatter'
 require 'rails_tracepoint_stack/tracer'
@@ -7,18 +6,21 @@ $rails_tracer_rtps = nil
 
 module RailsTracepointStack
   class << self
-    attr_accessor :configuration, :logger
+    attr_writer :configuration, :logger
+
+    def configuration
+      @configuration ||= RailsTracepointStack::Configuration.new
+    end
   end
 
   def self.configure
-    self.configuration ||= RailsTracepointStack::Configuration.new
     yield(configuration)
   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
@@ -26,8 +28,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.3
+  version: 0.3.5
 platform: ruby
 authors:
 - Carlos Daniel Pohlod
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-24 00:00:00.000000000 Z
+date: 2026-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -50,6 +50,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 13.0.0
+- !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: 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.
@@ -60,8 +80,12 @@ extra_rdoc_files: []
 files:
 - lib/rails_tracepoint_stack.rb
 - lib/rails_tracepoint_stack/configuration.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/log_formatter.rb
 - lib/rails_tracepoint_stack/logger.rb
 - lib/rails_tracepoint_stack/trace.rb
@@ -74,7 +98,7 @@ licenses:
 metadata:
   documentation_uri: https://github.com/carlosdanielpohlod/rails_tracepoint_stack/
   changelog_uri: https://github.com/carlosdanielpohlod/rails_tracepoint_stack/blob/main/changelog.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -89,8 +113,8 @@ 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.
 test_files: []