rails_tracepoint_stack 0.1.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fcdfb6d987f930a294785da2decd147c1f9f7c1e95ca5815f5f4aba38b0d81b
-  data.tar.gz: f02ced7d9f7413d101f16945737c0a3b8dabc3028859c787ccb63c2922d88da4
+  metadata.gz: a6e61976b25735790c540866ecebe19e2107f14ca9f2434fc0c176de91953303
+  data.tar.gz: 5df99b05328e5158e8763469e2f5f24ffd34fb914c251d88ef0bcb7f3ee96e49
 SHA512:
-  metadata.gz: 8adede1acb4f3391aa435070d2b0f1a8447c282bf85f35236ce25459401074e3b5d99beb66b3d6053d86b0d14a03060dcc209b30e0e5a0fca3b5a793432037e0
-  data.tar.gz: ba27381d62e176251babd86041f7362e44552987359dd66950a82b47b24a88d8026a0aa191b582c04076df05c6eefc650748766425ceaba4b6d1e70ccb746a0d
+  metadata.gz: 867a2672fd90e65f0244632cc2ba9f189c865d7d8ae81ea0004e2a8461770c61dabb0b9fc45a32c9e244218292cf6b8ca34beae31a965a7508fd1d90e4327283
+  data.tar.gz: 043e6d052f87535dccd6acaeaa224fe94337e2305ffbcdca392c946fbf3cfab4645648cc4b9d80252835018954376af16d8df76fd017e7693ec22d9d36e6f53b

data/lib/rails_tracepoint_stack/configuration.rb

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

data/lib/rails_tracepoint_stack/filter/gem_path.rb

@@ -0,0 +1,9 @@
+module RailsTracepointStack
+  module Filter
+    class GemPath
+      def self.full_gem_path
+        @full_gem_path ||= Bundler.load.specs.map(&:full_gem_path)
+      end
+    end
+  end
+end

data/lib/rails_tracepoint_stack/filter/rb_config.rb

@@ -0,0 +1,9 @@
+module RailsTracepointStack
+  module Filter
+    class RbConfig
+      def self.ruby_lib_path
+        @ruby_lib_path ||= ::RbConfig::CONFIG['rubylibdir']
+      end
+    end
+  end
+end

data/lib/rails_tracepoint_stack/log_formatter.rb

@@ -0,0 +1,26 @@
+module RailsTracepointStack
+  module LogFormatter
+    def self.message(trace)
+      case RailsTracepointStack.configuration&.log_format
+      when :json
+        json trace
+      else
+        text trace
+      end
+    end
+
+    def self.text(trace)
+      "called: #{trace.class_name}##{trace.method_name} in #{trace.file_path}:#{trace.line_number} with params: #{trace.params}"
+    end
+
+    def self.json(trace)
+      {
+        class: trace.class_name,
+        method_name: trace.method_name,
+        path: trace.file_path,
+        line: trace.line_number,
+        params: trace.params
+      }.to_json
+    end
+  end
+end

data/lib/rails_tracepoint_stack/logger.rb

@@ -0,0 +1,14 @@
+module RailsTracepointStack
+  class Logger
+    def self.log(msg)
+      if RailsTracepointStack.configuration&.logger
+        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|
+          f.puts msg
+        end
+      end
+    end
+  end
+end

data/lib/rails_tracepoint_stack/trace.rb

@@ -0,0 +1,30 @@
+require 'forwardable'
+
+module RailsTracepointStack
+  class Trace
+    extend Forwardable
+
+    attr_reader :params, :trace_point
+
+    def_delegator :@trace_point, :defined_class, :class_name
+    def_delegator :@trace_point, :method_id, :method_name
+    def_delegator :@trace_point, :path, :file_path
+    def_delegator :@trace_point, :lineno, :line_number
+
+    def initialize(trace_point:)
+      @trace_point = trace_point
+    end
+
+    def params
+      @params ||= fetch_params(trace_point)
+    end
+
+    private
+
+    def fetch_params(trace_point)
+      trace_point.binding.local_variables.map { |var|
+        [var, trace_point.binding.local_variable_get(var)]
+      }.to_h
+    end
+  end
+end

data/lib/rails_tracepoint_stack/trace_filter.rb

@@ -0,0 +1,60 @@
+require 'rails_tracepoint_stack/filter/gem_path'
+require 'rails_tracepoint_stack/filter/rb_config'
+
+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)
+      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)
+      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)
+      end
+    end
+  end
+end

data/lib/rails_tracepoint_stack/tracer.rb

@@ -0,0 +1,22 @@
+#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
+      @tracer ||= TracePoint.new(:call) do |tracepoint|
+        trace = RailsTracepointStack::Trace.new(trace_point: tracepoint)
+
+        next if RailsTracepointStack::TraceFilter.ignore_trace?(trace: trace)
+
+        # TODO: Use proper OO
+        message = RailsTracepointStack::LogFormatter.message trace
+        RailsTracepointStack::Logger.log message 
+      end
+    end
+  end
+end

data/lib/rails_tracepoint_stack/version.rb

@@ -0,0 +1,3 @@
+module RailsTracepointStack
+  VERSION = "0.3.0"
+end

data/lib/rails_tracepoint_stack.rb

@@ -1,43 +1,33 @@
-$rails_tracer_rtps = nil
-
-class RailsTracepointStack
-  def initialize
-    @gem_paths = Bundler.load.specs.map(&:full_gem_path)
-    @ruby_lib_path = RbConfig::CONFIG['rubylibdir']
-  end
+require 'json'
+require 'rails_tracepoint_stack/configuration'
+require 'rails_tracepoint_stack/log_formatter'
+require 'rails_tracepoint_stack/tracer'
 
-  def tracer
-    @trace ||=  TracePoint.new(:call) do |tp|
-      next if start_with_to_ignore_prefixes?(tp) || from_gempath_or_lib_path?(tp)
+$rails_tracer_rtps = nil
 
-      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) || 
-    tp.path.include?("gems/bundler") 
+    tracer = RailsTracepointStack::Tracer.new.tracer
+    tracer.enable
+    yield
+  ensure
+    tracer.disable
   end
 end
 
-if ENV.fetch('RAILS_TRACEPOINT_STACK', 'false') == 'true'
-  $rails_tracer_rtps = RailsTracepointStack.new.tracer
+if ENV.fetch('RAILS_TRACEPOINT_STACK_ENABLED', 'false') == 'true'
+  $rails_tracer_rtps = RailsTracepointStack::Tracer.new.tracer
   $rails_tracer_rtps.enable
 
   at_exit do

metadata

@@ -1,15 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: rails_tracepoint_stack
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.3.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-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !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.
@@ -19,11 +59,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/rails_tracepoint_stack.rb
+- lib/rails_tracepoint_stack/configuration.rb
+- lib/rails_tracepoint_stack/filter/gem_path.rb
+- lib/rails_tracepoint_stack/filter/rb_config.rb
+- lib/rails_tracepoint_stack/log_formatter.rb
+- lib/rails_tracepoint_stack/logger.rb
+- lib/rails_tracepoint_stack/trace.rb
+- lib/rails_tracepoint_stack/trace_filter.rb
+- lib/rails_tracepoint_stack/tracer.rb
+- lib/rails_tracepoint_stack/version.rb
 homepage: https://github.com/carlosdanielpohlod/rails_tracepoint_stack/
 licenses:
 - MIT
 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: