rails_tracepoint_stack 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eeb97f7192b4379bdebd15da84477298535c897236b3a3acb2735f89db5ebd7b
-  data.tar.gz: 809557f925e2fd9e85302eef08497792ccc525b3f5b25662266fc4f6cc76e770
+  metadata.gz: 874f14c9b66717408755c8bae182634b457f23ae684ec5cc6eb1bb2b07aa5865
+  data.tar.gz: e23e31fd3558896656efbb58796d9fc689f535b0835e646602eaa3590fba89af
 SHA512:
-  metadata.gz: a903d86229c926bbfcbcbeb75971c3aa2891b35327fe6608ce29c6b88f2c7f3e97c135d66c9783f0632fd9286a88df558be187389b9332f0407431878ff65cdc
-  data.tar.gz: d65ba8f3c6fb40c9c2a505dd8cc771f8de357dc0dc5de724ba7a118f8f772dd66773c4dd6cf087d8c3c3bce4c05d75bc35fa0cf7d52c98cb874213204b8b70ac
+  metadata.gz: 13efe4146269be0aa124022ca0b7fca5eaa8a91611a9a8e1f59af24d82af70f815f9853b0a4b93b5c1dd7de9401af13341e82f59b5ace70a0b47b1298b446c6c
+  data.tar.gz: 0bdc7578909e62f51dddf52b65e2de7a37d7afc1f8cdf794427bfda3e022ac1396627c3ffc2e5ee117fd322f81f1ec4f54ebad2172ffb2571779e8c890ff8bc3

data/lib/rails_tracepoint_stack/configuration.rb

@@ -0,0 +1,10 @@
+module RailsTracepointStack
+  class Configuration
+    attr_accessor :ignore_patterns, :logger
+
+    def initialize
+      @ignore_patterns = []
+      @logger = nil
+    end
+  end
+end

data/lib/rails_tracepoint_stack/logger.rb

@@ -0,0 +1,14 @@
+module RailsTracepointStack
+  class Logger
+    def self.log(msg)
+      unless RailsTracepointStack.configuration&.logger
+        File.open('log/rails_tracepoint_stack.log', 'a') do |f|
+          f.puts msg
+        end
+      else
+        RailsTracepointStack.configuration.logger.info(msg)
+      end
+    end
+  end
+end
+

data/lib/rails_tracepoint_stack/trace_filter.rb

@@ -0,0 +1,31 @@
+module RailsTracepointStack
+  class TraceFilter
+    def self.ignore_trace?(trace:)
+      start_with_to_ignore_prefixes?(trace) || from_gempath_or_lib_path?(trace) || is_a_to_ignore_pattern?(trace)
+    end
+
+    private
+
+    def self.gem_paths
+      @gem_paths ||= Bundler.load.specs.map(&:full_gem_path)
+    end
+
+    def self.ruby_lib_path
+      @ruby_lib_path ||= RbConfig::CONFIG['rubylibdir']
+    end
+    
+    def self.start_with_to_ignore_prefixes?(trace)
+      trace.path.start_with?('<internal:') || trace.path == '(eval)'
+    end
+
+    def self.from_gempath_or_lib_path?(trace)
+      gem_paths.any? { |path| trace.path.start_with?(path) } || 
+        trace.path.start_with?(ruby_lib_path) || 
+          trace.path.include?("gems/bundler")
+    end
+
+    def self.is_a_to_ignore_pattern?(trace)
+      RailsTracepointStack.configuration&.ignore_patterns&.any? { |pattern| trace.path.match?(pattern) }
+    end
+  end
+end

data/lib/rails_tracepoint_stack/tracer.rb

@@ -0,0 +1,25 @@
+require 'rails_tracepoint_stack/logger'
+require 'rails_tracepoint_stack/trace_filter'
+
+module RailsTracepointStack
+  class Tracer
+    def tracer
+      @trace ||= TracePoint.new(:call) do |tp|
+        next if RailsTracepointStack::TraceFilter.ignore_trace?(trace: tp)
+
+        params = fetch_params(tp)
+        
+        RailsTracepointStack::Logger.log "called: #{tp.defined_class}##{tp.method_id} in #{tp.path}:#{tp.lineno} with params: #{params}"
+      end
+    end
+
+    private
+    attr_reader :gem_paths, :ruby_lib_path
+
+    def fetch_params(tp)
+      tp.binding.local_variables.map { |var|
+        [var, tp.binding.local_variable_get(var)]
+      }.to_h
+    end
+  end
+end

data/lib/rails_tracepoint_stack.rb

@@ -1,41 +1,34 @@
+require 'rails_tracepoint_stack/configuration'
+require 'rails_tracepoint_stack/tracer'
 
-class TracepointStack
-  def initialize
-    @gem_paths = Bundler.load.specs.map(&:full_gem_path)
-    @ruby_lib_path = RbConfig::CONFIG['rubylibdir']
-  end 
+$rails_tracer_rtps = nil
 
-  def tracer
-    @trace ||=  TracePoint.new(:call) do |tp|
-      next if start_with_to_ignore_prefixes?(tp) || from_gempath_or_lib_path?(tp)
-
-      params = fetch_params(tp)
-      
-      puts "called: #{tp.defined_class}##{tp.method_id} in #{tp.path}:#{tp.lineno} with params: #{params}"
-    end
+module RailsTracepointStack
+  class << self
+    attr_accessor :configuration, :logger
   end
 
-  private
-  attr_reader :gem_paths, :ruby_lib_path
-
-  def fetch_params(tp)
-    tp.binding.local_variables.map { |var|
-      [var, tp.binding.local_variable_get(var)]
-    }.to_h
+  def self.configure
+    self.configuration ||= RailsTracepointStack::Configuration.new
+    yield(configuration)
   end
 
-  def start_with_to_ignore_prefixes?(tp)
-    tp.path.start_with?('<internal:') || tp.path == '(eval)'
-  end
+  def self.enable_trace
+    raise ArgumentError, "Block not given to #enable_trace" unless block_given?
 
-  def from_gempath_or_lib_path?(tp)
-    gem_paths.any? { |path| tp.path.start_with?(path) } || tp.path.start_with?(ruby_lib_path)
+    tracer = RailsTracepointStack::Tracer.new.tracer
+    tracer.enable
+    yield
+  ensure
+    tracer.disable
   end
 end
 
-tracer = TracepointStack.new.tracer
-tracer.enable
+if ENV.fetch('RAILS_TRACEPOINT_STACK', 'false') == 'true'
+  $rails_tracer_rtps = RailsTracepointStack::Tracer.new.tracer
+  $rails_tracer_rtps.enable
 
-at_exit do
-  tracer.disable
+  at_exit do
+    $rails_tracer_rtps.disable
+  end
 end

metadata

@@ -1,15 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: rails_tracepoint_stack
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Carlos Daniel Pohlod
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
-dependencies: []
+date: 2024-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.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.
@@ -19,10 +59,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/rails_tracepoint_stack.rb
+- lib/rails_tracepoint_stack/configuration.rb
+- lib/rails_tracepoint_stack/logger.rb
+- lib/rails_tracepoint_stack/trace_filter.rb
+- lib/rails_tracepoint_stack/tracer.rb
 homepage: https://github.com/carlosdanielpohlod/rails_tracepoint_stack/
 licenses:
 - MIT
-metadata: {}
+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: 
 rdoc_options: []
 require_paths:
@@ -31,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="